https://github.com/Animenosekai/python-module-template
A template repository for Python modules
https://github.com/Animenosekai/python-module-template
Last synced: 6 months ago
JSON representation
A template repository for Python modules
- Host: GitHub
- URL: https://github.com/Animenosekai/python-module-template
- Owner: Animenosekai
- License: mit
- Created: 2021-06-23T21:34:46.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-07-06T23:01:30.000Z (over 4 years ago)
- Last Synced: 2024-11-09T10:44:31.567Z (about 1 year ago)
- Language: Python
- Size: 9.77 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `module_name`
> Short description
***Catchphrase!***
[](https://pypi.org/project/module_name/)
[](https://pypistats.org/packages/module_name)
[](https://pypi.org/project/module_name/)
[](https://pypi.org/project/module_name/)
[](https://github.com/Animenosekai/module_name/blob/master/LICENSE)
[](https://github.com/Animenosekai/module_name)
[](https://github.com/Animenosekai/module_name/actions?query=workflow%3ACodeQL)
[](https://github.com/Animenosekai/module_name/actions/workflows/pytest.yml)
## Getting Started
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.
### Prerequisites
You will need Python 3 to use this module
```bash
# 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
## Installing
### Option 1: From PyPI
```bash
pip install module_name
```
### Option 2: From Git
```bash
pip install git+https://github.com/Animenosekai/module_name
```
You can check if you successfully installed it by printing out its version:
```bash
$ python -c "import module_name; print(module_name.__version__)"
# output:
module_name v1.0
```
or just:
```bash
$ module_name --version
# output:
module_name v2.0
```
## Usage
You can use module_name in Python by importing it in your script:
```python
import module_name
module_name.function()
```
### CLI usage
You can use module_name in other apps by accessing it through the CLI version:
```bash
$ module_name
output
```
#### Interactive Shell (REPL)
An interactive version of the CLI is also available
```bash
$ module_name shell
>>>
```
### As a Python module
#### Class Name
Paragraph explaining the class
#### How to use
Paragraph to explain
#### Cache
Paragraph to explain
#### Example
Examples
```python
from module_name import function
function()
```
## Deployment
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.
## Built With
- [dependency](https://dependency-home-page.com) - To do this
- [dependency](https://dependency-home-page.com) - To do this
## Authors
- **Anime no Sekai** - *Initial work* - [Animenosekai](https://github.com/Animenosekai)
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for more details
## Acknowledgments
- Thanks to *someone* for helping me with [...]