projup is a project setup tool written in python. It will generate typical files and folders for you, after you entered the project configuration. You can easily modify it to fit your needs.
- easy & fast project setup
- easy to modify
- easy to setup itself
projup requires python 3.4+ and pipenv
- If you do not have python installed yet, install it.
- If you do not have pipenv installed yet, run
pip install pipenv
- Clone the repository
- Run
pipenv sync
in the projup folder - Go to a folder, in which you want to create your projects and run
pipenv run python path/to/projup/app.py
Do not run it inside of a pipenv enviroment if you want to set up a python project, else the pipenv commands will be executed on the wrong project.
- Setup with
pipenv sync --dev
- Run
pipenv run python test.py
in the projup folder
projup takes your input and puts that on some templates. Those you can find in
the templates
folder. You can change them to fit your needs.
To not have to type your name and email again and again on one system, you can
instead create a projup config file in your home directory with the following
content: (~/.projup
)
author = "My Name"
email = "info@example.com"
- Create a GitHub issue
- Create a pull request with an own branch
- Add yourself to the AUTHORS file.
- Run
pipenv sync --dev
if you didn't do it yet. - Make sure, that you run
pipenv run yapf -i -r *.py
before you commit.