Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cknoll/python-project-template

Last synced: about 20 hours ago
JSON representation

Host: GitHub
URL: https://github.com/cknoll/python-project-template
Owner: cknoll
License: other
Created: 2024-09-10T23:09:04.000Z (2 months ago)
Default Branch: main
Last Pushed: 2024-09-13T06:20:59.000Z (2 months ago)
Last Synced: 2024-10-13T11:31:02.726Z (about 1 month ago)
Language: Python
Size: 18.6 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

# General Information

This repository holds the basic directory layout for new python projects. Additional to a reasonable minimum of features (setup.py, requirements.txt, directory structure, ...) it contains the following extras:

- basic unittest

- `script.py` and associated entrypoint in `pyproject.toml` (allows to call some functionality of the package directly from command line (try `package_name cmd1`))

## Usage

- Rename directory `src/package_name`

- Edit `pyproject.toml`: replace dummy data with real data.

- Add your source. a) Either to [`core.py`](src/package_name/core.py) or b) to your own separate file(s).

    - a) simplifies importing your module

    - b) is more flexible but you have to take care of importability yourself.

For local development it is recommended to install this (better: your) package in [editable mode](https://pip.pypa.io/en/latest/cli/pip_wheel/?highlight=editable#cmdoption-e): `pip install -e .` (run from where `pyproject.toml` lives).

## Publishing on pypi

To publish your package on [Python Package Index (pypi)](pypi.org/) the following commands should work:

- Install necessary tooling: `pip install build setuptools_scm twine`

- create the uploadable pack: `rm -rf dist/*; python3 -m build`

- Register a username on 

- upload package: `twine upload -r pypi dist/*`

    - use this for testing `twine upload -r testpypi dist/*`