It is a code generator for Python projects.
Project description
This tool generates help you start a new Python project by generating its starting code. In the current stage it only generates very simple project, but more is planned to be added in the future (including a Flask project with features selection).
To install this tool run:
pip install python-project-creator
After installing you will have access to the ppc
tool on your terminal. To know more about the tool and its commands run:
ppc --help
You can use the command create
to create a new project. It follows the syntax:
ppc create --template <template> <output>
Where:
- template: The template to use for the project. If no template is informed the basic template will be used (check more below).
- output: The output directory where the project will be created.
Currently it support the folloging templates:
Basic
This is a very simple template to use when starting a new project. It only creates a blank main.py
file.
To use this template run:
ppc create --template basic <output>
CP
This template can be used when solving programming exercises in Online Judges (OJs) using the Python language. Some examples of OJs are Neps Academy, Codeforces, Kattis and Beecrowd.
This template will create the following structure:
- main.py
- input.txt
- output.txt
Where main.py
can be used to solve the problem. The input and output files are used to test the solution.
To use this template run:
ppc create --template cp <output>
PIP
This template creates the structure that is needed when creating a package that will be uploaded to PiPy.
It will create:
- module folder: where you will write your module's code.
- main.py: to showcase a concrete example using your module.
- setup.py: contains the configuration of your project and creates the wheel needed when uploading your module to PiPy.
- README.md: where you will describe what is and how to use your module.
To use this template run:
ppc create --template pip <output>
This template will ask for some additional information during the creating. The information you provide will be filled in some parts of your project's files.
Build and Upload
To build new this project run:
python setup.py sdist
python setup.py bdist_wheel
To upload a new version use (don't forget to update the version number in setup.py
):
twine upload dist/*
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file python-project-creator-0.1.0.tar.gz
.
File metadata
- Download URL: python-project-creator-0.1.0.tar.gz
- Upload date:
- Size: 20.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.10.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3922471d76c842895f3d0498326d92d2ab3f01bf011b24304011b8fc3080ba21 |
|
MD5 | 60f973d8d9546ea29ff52889233a3916 |
|
BLAKE2b-256 | 3fb2664bd6335a0da6e6400e8393c1bbb8a16f1f97a7fa0cd7a74e12260bc9a7 |
File details
Details for the file python_project_creator-0.1.0-py3-none-any.whl
.
File metadata
- Download URL: python_project_creator-0.1.0-py3-none-any.whl
- Upload date:
- Size: 20.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.10.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | dac499a0d4b93cdbc1239dd9364e7c7a96948998b43c8a26462ac4f20fa3ff97 |
|
MD5 | e3c28e9b80e8324088d5e2e8bb67e584 |
|
BLAKE2b-256 | 2499eb1931fe06dc5453893156cc93a444e48dc4dbfb9aa7e9f24582e18ed738 |