pyproject-maker 0.12.0

A command line app to create a Python project skeleton.

Python Project Generation Tool

A fully customizable Python application to bootstrap Poetry-based boilerplate for you to start developing your Python applications quicker! Includes linting and Pytest libraries, a task runner, pre-commit hooks, and optionally create a git repository and upload to GitHub. you can also fully customize the template used.

Full documentation for this project with usage examples is available at https://py-maker.seapagan.net/

• Installation
• Usage
  • Linting
  • Customise
  • Task Runner
  • Pre-commit
• GitHub Actions and Configuration
• Contributing to Py-Maker
• License

Installation

It is best to install this package globally, rather than in a virtual environment, as it is intended to be used to create new projects.

Install the package globally using pip:

$ pip install pyproject-maker

If you cannot install globally due to permissions, you can install it to your user install directory:

$ pip install --user pyproject-maker

or use pipx (recommended)

$ pipx install pyproject-maker

Usage

To create a new project, run the following command:

$ pymaker new <project-folder>

This will create a new directory with the name you provide, and run the steps needed to get you started quickly:

1. Copy the template files into the new directory
2. Initialise a git repository
3. Commit the boilerplate to Git

You will be asked a series of questions to customise the new project.

When it asks "Package Name?" you can choose two variants :

1. If you wish for a standard Python package that can optionally be uploaded to http://pypi.org, enter a package name here. Note that underscores ("_") must be used as opposed to dashes ("-") to comply with Python package naming rules.
2. Enter '-' (a dash) to instruct the tool that you are not creating any package, just a standalone app, and then the main.py will just be placed in the project root. The pyproject.toml file will not include any package information and Poetry will never try to install or publish the package.

You should now change into the new directory, install dependencies and activate the virtual environment:

$ cd <project-folder>
$ poetry install
$ poetry shell

Now, you can start developing :smile:

Linting

The generated project includes Ruff for linting and formatting. Mypy is installed for type checking.

Customise

For a 'package' project, the pyproject.toml file is set up to put the code in a sub-folder with the same name as chosen for the 'Package Name'. You can change this to whatever you require, just remember to update the pyproject.toml file to match.

You can also modify the template used to generate the new project.

Check the documentation at https://py-maker.seapagan.net/ for more details.

Task Runner

The task-runner Poe the Poet is installed as a development dependency which allows us to run simple tasks (similar to npm scripts).

These are run (from within the virtual environment) using the poe command and then the script name, for example:

$ poe pre

See the Task Runner section in the documentation for more details and a list of available tasks.

These are defined in the pyproject.toml file in the [tool.poe.tasks] section. Take a look at this file if you want to add or remove tasks.

Pre-commit

The generated project uses pre-commit to run some checks on the code before it is committed. This is a great tool to help keep your code clean.

To install pre-commit, run the following command from inside your venv:

$ pre-commit install
pre-commit installed at .git/hooks/pre-commit

GitHub Actions and Configuration

By default the generated project includes a GitHub Actions workflow to run Dependabot to keep your dependencies up to date. There are also standard templates for Pull Request and Issues.

The plan is to add more workflows in the future, for example running tests and more.

Contributing to Py-Maker

All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome.

A detailed overview on how to contribute can be found in the contributing guide and on the website.

If you are simply looking to start working with the codebase, navigate to the GitHub "issues" tab and start looking through interesting issues. There may be issues listed under documentation and good first issue where you could start out.

You can also triage issues which may include reproducing bug reports, or asking for vital information such as version numbers or reproduction instructions.

Maybe through using Py-Maker you have an idea of your own or are looking for something in the documentation and thinking ‘this can be improved’...you can do something about it!

As contributors and maintainers to this project, you are expected to abide by our code of conduct. More information can be found at: Contributor Code of Conduct

License

This project is licensed under the terms of the MIT license.

MIT License

Copyright (c) 2023 Grant Ramsay

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.