create-python-proj 1.0.5

Set up a modern Python project by running one command.

Create Python Proj

Set up a modern Python project by running one command. (The missing Create React App for Python)

Create Python projects with the best development tools and configurations.

• Creating a Project – How to create a new project.

Create Python Project works on macOS, Windows, and Linux.
If something doesn’t work, please file an issue.

This is the best Python workflow setup, and you deserve the best.

"A customer can have a car painted any colour he wants as long as it's black."

Quick Overview

pipx install create-python-proj
create-python-proj
cd my-proj
poetry shell
poetry run my-proj

If you've previously installed create-python-proj via pipx install create-python-proj, we recommend you run pipx upgrade create-python-proj to ensure that you are always using the latest version.

Get Started Immediately

You don’t need to manually install or configure tools like Poetry, flake8, or mypy. They are preconfigured and hidden so that you can focus on the code.

Create a project with the best setup, and you’re good to go.

Creating a Project

This package automates the process of creating a new Python project managed using Poetry. It sets up the project structure, initializes a Git repository, configures the best development tools: mypy, black, flake8, isort, pytest, and pytest-sugar, and adds the best configurations for these tools.

To create a new project, simply install using pipx:

pipx install create-python-proj

Then run the tool:

create-python-proj

You will be prompted for the project name and create a new directory with the project structure and configurations will be created.

If you don't have pipx installed, you can install it with:

python3 -m pip install --user pipx

(pipx is a Python package runner tool for running https://pypi.org/ packages)

It will create a directory called my-proj inside the current folder.
Inside that directory, it will generate the initial project structure and install the transitive dependencies:

my-proj
├── pyproject.toml
├── poetry.lock
├── README.md
├── .gitignore
├── .flake8
├── .venv
│   └── ...local Python virtual environment
├── my-proj
│   ├── __init__.py
│   └── main.py
└── tests
    ├── __init__.py
    └── test_example.py

No configuration or complicated folder structures, only the files you need to build your app. Once the installation is done, you can open your project folder and activate the local virtual environment, managed by Poetry:

cd my-proj
poetry shell

Inside the newly created project, you can run your program:

poetry run my-proj

Runs the starter "Hello, World!" program.

pytest

Runs the starter test_example test.

Contributing

Contributions to Create-Python-Proj are welcome. To contribute, please follow these steps:

1. Fork the repository on GitHub.
2. Create a new branch with a descriptive name.
3. Commit your changes to the new branch.
4. Create a pull request, and describe the changes you made.

Please make sure to follow the project's coding standards and add tests for any new features.

License

Create-Python-Proj is licensed under the MIT License. For more information, see the LICENSE file in the repository.