My Best Python Project
Project description
My best python project
This is a sample project.
Installation
pip install git+https://github.com/eggplants/my-best-python-project
# or,
pip install my-best-python-project
Usage
CLI
$ mbpp -h
usage: mbpp [-h] [-o PATH] [--overwrite] [-q] [-V]
This command prints package's version.
optional arguments:
-h, --help show this help message and exit
-o PATH, --output PATH output to file (default: None)
--overwrite overwrite when using `-o` (default: False)
-q, --quiet quiet mode (default: False)
-V, --version show program's version number and exit
note:
This package and tool is a sample.
$ mbpp
This package's version is: 0.0.1
$ mbpp -q
0.0.1
$ mbpp -o test.txt
Output: 'test.txt'
$ mbpp -o test.txt
Error: File 'test.txt' exists. To overwrite, use `-o`.
$ mbpp -o test.txt --overwrite
Output: 'test.txt'
Library
To print this package's version:
import my_best_python_project
print(my_best_python_project.__version__)
Docker
To build docker image locally:
# build:
curl 'https://raw.githubusercontent.com/eggplants/my-best-python-project/master/Dockerfile' | docker build -t eggplanter/mbpp -f-
To run:
$ docker run --rm -it eggplanter/mbpp
This package's version is: 0.0.2
$ docker run --rm -it eggplanter/mbpp -h
usage: mbpp [-h] [-o PATH] [--overwrite] [-q] [-V]
This command prints package's version.
options:
-h, --help show this help message and exit
-o PATH, --output PATH output to file (default: None)
--overwrite overwrite when using `-o` (default: False)
-q, --quiet quiet mode (default: False)
-V, --version show program's version number and exit
note:
This package and tool is a sample.
Development
To setup development environment:
pip install -e ".[all]"
pre-commit install
To run pre-commit hooks manually:
pre-commit run
# or,
pre-commit run --all-fileso
License
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Close
Hashes for my-best-python-project-0.0.3.zip
Algorithm | Hash digest | |
---|---|---|
SHA256 | ee37cf85d0f970c7eae7af1cffb4c93d1acb85f888244a8434388f16e0b7deb4 |
|
MD5 | 77839672d60c194e1675eaf2a293e8e8 |
|
BLAKE2b-256 | 86e3b69a6e4bfdb3be48078792277d9ce6d8110c2ee3388095d330e2f519c97c |