Skip to content

Latest commit

 

History

History
79 lines (54 loc) · 2.41 KB

README.md

File metadata and controls

79 lines (54 loc) · 2.41 KB

(Insert GitHub Actions/codecov status badges here)

README

Prerequisites

Create a new repository for your module on GitHub with no files.

Create a new Python 3.10 (install it beforehand) virtual environment using venv and switch to it.

python3.10 -u -m venv ~/venv-startrepo ;

source ~/venv-startrepo/bin/activate && pip install --upgrade uv ;

Create a new module

Running in the above venv:

(venv-startrepo) $ git clone [email protected]:nth10sd/startrepo.git

(venv-startrepo) $ git clone REPLACEME
                             ^^^^^^^^^

(venv-startrepo) $ cd REPLACEME
                      ^^^^^^^^^

(venv-startrepo) $ cp -r ../startrepo/* ../startrepo/.gitignore ../startrepo/.vulture_allowlist ../startrepo/.github . && rm -rf build/ *.egg*-info/

(venv-startrepo) $ mv startrepo/ REPLACEME
                                 ^^^^^^^^^

(venv-startrepo) $ find . ! \( -path ./.git -prune \) -type f | xargs sed -i 's/startrepo/REPLACEME/g'
                                                                                          ^^^^^^^^^

Install your module by running:

(venv-startrepo) $ uv pip install --upgrade -r requirements.txt -e . ;

Run your new module using:

(venv-startrepo) $ python -u -m REPLACEME
                                ^^^^^^^^^

Delete the CodeQL steps in the GitHub Actions .yml workflow settings file if they are not required.

Run tools on your package

(All commands here must be run within the venv, in the main repository directory - not any subfolders)

For linters only:

for TOOL in ruff mypy pylint ; do "$TOOL" $(python -c "from pathlib import Path; exec('try: import tomllib\nexcept ImportError: import tomli as tomllib\nwith Path(\"pyproject.toml\").open(mode=\"rb\") as fp:\n cfg = tomllib.load(fp)\n print(f\'{cfg[\"project\"][\"name\"]}/{\" tests/\" if Path(\"tests/\").is_dir() else \"\"}\')')") ; done;

For comprehensive tests and all linters:

python -u -m pytest --cov --mypy --pylint --ruff --ruff-format

For comprehensive tests and all linters except slow tests:

python -u -m pytest --cov --mypy --pylint --ruff --ruff-format -m "not slow"

Documentation generation via Sphinx

  • Change into docs/ folder: cd docs/
  • Run generation command - you must first be in the docs/ directory: ./gen-sphinx-html.sh
  • Your generated HTML files are now in docs/build/html/ directory
  • Open index.html to start