pyscaff 0.1.0

Make and manage templates for Python projects

Copyright (c) 2024 Jérémie DECOCK (www.jdhp.org)

• Web site: http://www.jdhp.org/software_en.html#pyscaff

• Online documentation: https://jdhp-dev.gitlab.io/pyscaff

• Examples: https://jdhp-dev.gitlab.io/pyscaff/gallery/

• Notebooks: https://gitlab.com/jdhp-dev/pyscaff-notebooks

• Source code: https://gitlab.com/jdhp-dev/pyscaff

• Issue tracker: https://gitlab.com/jdhp-dev/pyscaff/issues

• Pytest code coverage: https://jdhp-dev.gitlab.io/pyscaff/htmlcov/index.html

• Pyscaff on PyPI: https://pypi.org/project/pyscaff

Description

Make and manage templates for Python projects

Note:

This project is still in beta stage, so the API is not finalized yet.

Dependencies

C.f. requirements.txt

Installation (development environment)

Posix (Linux, MacOSX, WSL, …)

From the Pyscaff source code:

conda deactivate         # Only if you use Anaconda...
python3 -m venv env
source env/bin/activate
python3 -m pip install --upgrade pip
python3 -m pip install -r requirements-dev.txt

Windows

From the Pyscaff source code:

conda deactivate         # Only if you use Anaconda...
python3 -m venv env
env\Scripts\activate.bat
python3 -m pip install --upgrade pip
python3 -m pip install -r requirements-dev.txt

Installation (production environment)

python3 -m pip install --no-cache-dir "pyscaff @ git+ssh://[e-mail]/jdhp-dev/pyscaff.git"

Documentation

• Online documentation: https://jdhp-dev.gitlab.io/pyscaff

• API documentation: https://jdhp-dev.gitlab.io/pyscaff/api.html

Example usage

pyscaff new --template-directory-path=./examples/template_test --project-config-path=./examples/pyscaff-config.toml --output-directory-path=./examples/output

Bug reports

To search for bugs or report them, please use the Pyscaff Bug Tracker at:

https://gitlab.com/jdhp-dev/pyscaff/issues

License

This project is provided under the terms and conditions of the MIT License.