Short description
Catchphrase!
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
You will need Python 3 to use this module
# vermin output
Minimum required versions: 3.2
Incompatible versions: 2
According to Vermin (--backport typing
), Python 3.2 is needed for the backport of typing but some may say that it is available for python versions higher than 3.0
Always check if your Python version works with module_name
before using it in production
pip install module_name
pip install git+https://github.com/Animenosekai/module_name
You can check if you successfully installed it by printing out its version:
$ python -c "import module_name; print(module_name.__version__)"
# output:
module_name v1.0
or just:
$ module_name --version
# output:
module_name v2.0
You can use module_name in Python by importing it in your script:
import module_name
module_name.function()
You can use module_name in other apps by accessing it through the CLI version:
$ module_name
output
An interactive version of the CLI is also available
$ module_name shell
>>>
Paragraph explaining the class
Paragraph to explain
Paragraph to explain
Examples
from module_name import function
function()
This module is currently in development and might contain bugs.
Feel free to use it in production if you feel like it is suitable for your production even if you may encounter issues.
- dependency - To do this
- dependency - To do this
- Anime no Sekai - Initial work - Animenosekai
This project is licensed under the MIT License - see the LICENSE file for more details
- Thanks to someone for helping me with [...]