Package: pyproject-maker
Python Project Generation ToolA fully customizable Python application to bootstrapPoetry-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 athttps://py-maker.seapagan.net/InstallationUsageLintingCustomiseTask RunnerPre-commitGitHub Actions and ConfigurationContributing to Py-MakerLicenseInstallationIt 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:$pipinstallpyproject-makerIf you cannot install globally due to permissions, you can install it to your
user install directory:$pipinstall--userpyproject-makeror usepipx(recommended)$pipxinstallpyproject-makerUsageTo create a new project, run the following command:$pymakernew<project-folder>This will create a new directory with the name you provide, and run the steps
needed to get you started quickly:Copy the template files into the new directoryInitialise a git repositoryCommit the boilerplate to GitYou will be asked a series of questions to customise the new project.When it asks "Package Name?" you can choose two variants :If you wish for a standard Python package that can optionally be uploaded tohttp://pypi.org, enter a package name here. Note that underscores ("_")
must be used as opposed to dashes ("-") to comply with Python package naming
rules.Enter '-' to instruct the tool that you are not creating any package, just a
standalone app, and then themain.pywill just be placed in the project
root.You should now change into the new directory, install dependencies and activate
the virtual environment:$cd<project-folder>$poetryinstall$poetryshellNow, you can start developing :smile:LintingThe generated project includesRufffor linting
and formatting.Mypyis installed for type checking.CustomiseFor a 'package' project, thepyproject.tomlfile 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 thepyproject.tomlfile
to match.You can also modify the template used to generate the new project.Check the documentation athttps://py-maker.seapagan.net/for more details.Task RunnerThe task-runnerPoe the Poetis installed
as a development dependency which allows us to run simple tasks (similar to npmscripts).These are run (from within the virtual environment) using thepoecommand and
then the script name, for example:$poepreYou can define your own, but there are 6 specific ones provided with the script.pre: Runpre-commit run --all-filesruff: Run Ruff linter on all Python files in the project.format: Run Ruff formatter on all Python files in the project.mypy: Run MyPy type-checker on all Python files in the project.markdown: Run pymarkdown on all markdown files in the project.lint: Runs ruff, format, mypy, and markdown in sequenceThese are defined in thepyproject.tomlfile in the[tool.poe.tasks]section. Take a look at this file if you want to add or remove tasks.Pre-commitThe generated project usespre-committo 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-commitinstallpre-commit installed at .git/hooks/pre-commitGitHub Actions and ConfigurationBy default the generated project includes a GitHub Actions workflow to runDependabotto 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-MakerAll contributions, bug reports, bug fixes, documentation improvements,
enhancements, and ideas are welcome.A detailed overview on how to contribute can be found in thecontributing
guideand on thewebsite.If you are simply looking to start working with the codebase, navigate to theGitHub "issues" taband start
looking through interesting issues. There may be issues listed underdocumentationandgood first
issuewhere 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
ConductLicenseThis 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.