https://github.com/prashantrahul141/python-package-structure
This contains a template for structuring python package.
https://github.com/prashantrahul141/python-package-structure
github-actions package python python-package python-package-template
Last synced: 3 months ago
JSON representation
This contains a template for structuring python package.
- Host: GitHub
- URL: https://github.com/prashantrahul141/python-package-structure
- Owner: prashantrahul141
- License: mit
- Created: 2022-12-28T10:27:24.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-12-28T10:42:29.000Z (about 3 years ago)
- Last Synced: 2025-07-06T12:02:34.387Z (6 months ago)
- Topics: github-actions, package, python, python-package, python-package-template
- Language: Python
- Homepage:
- Size: 1.59 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Python Package Structure
This contains a template for structuring python packages. Learn more.
## This covers:
- Structuring python packages
- Using sub modules to separate code
- Importing submodules
- Importing resources like images
- Testing (pytest, mypy)
- Linting (flake8)
- Github actions with tox
## Some useful commands:
Building package
```sh
# first make sure build is installed and updated
pip install --upgrade build
# then run the build command
python -m build
```
Install user dependencies
```sh
pip install -r requirements.txt
```
Install dev dependencies
```sh
pip install -r requirements_dev.txt
```
Install the package locally in editable mode
```sh
pip install -e .
```
run pytest to run your tests
```sh
pytest
```
run flake8 to test linting
```sh
flake8
```
get a cool `test:status` badge on your readme :D
```
```