https://github.com/eggplants/my-best-python-project

A Sample Project For Python - Badge, CLI, Code Climate, Docker, GitHub Pages, Linter configuration, Packaging, {GitHub,PyPI,GitHub Container Registry} releaser CI, Type Hints, pre-commit.ci, ...
https://github.com/eggplants/my-best-python-project

Last synced: 7 months ago
JSON representation

A Sample Project For Python - Badge, CLI, Code Climate, Docker, GitHub Pages, Linter configuration, Packaging, {GitHub,PyPI,GitHub Container Registry} releaser CI, Type Hints, pre-commit.ci, ...

• Host: GitHub
• URL: https://github.com/eggplants/my-best-python-project
• Owner: eggplants
• License: mit
• Created: 2022-04-21T09:14:13.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2025-05-06T08:28:38.000Z (over 1 year ago)
• Last Synced: 2025-05-06T09:41:37.883Z (over 1 year ago)
• Language: Python
• Homepage: https://egpl.dev/my-best-python-project/
• Size: 422 KB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# My best python project

[![PyPI](

  

  )](

  

) [![Release Package](

  

  )](

  

) [![CI](

  

  )](

  

)

This is a sample project.

## Installation

```sh

pip install my-best-python-project

# or, (use as CLI only)

pipx install my-best-python-project

```

## Usage

### CLI

```shellsession

$ 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: File 'test.txt'

$ mbpp -o test.txt

Error: File 'test.txt' exists. To overwrite, use `--overwrite`.

$ mbpp -o test.txt --overwrite

Output: File 'test.txt'

```

### Library

To print this package's version:

```python

import my_best_python_project

print(my_best_python_project.__version__)

```

### Docker

To pull and rename:

```shellsession

docker pull ghcr.io/eggplants/my-best-python-project

docker tag ghcr.io/eggplants/my-best-python-project mbpp

docker rmi ghcr.io/eggplants/my-best-python-project

```

To run:

```shellsession

$ docker run --rm -it mbpp -h

This package's version is: 0.0.2

$ docker run --rm -it 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.

```

## License

[MIT License](https://github.com/eggplants/my-best-python-project/blob/master/LICENSE)