Skip to content

Rollout is your one-stop solution to bootstrap Python projects, including essentials like Git and a virtual environment.

License

Notifications You must be signed in to change notification settings

AbsoluteRich/Rollout

Repository files navigation

Rollout (WIP)

standard-readme compliant Code style: black wakatime

Rollout is your one-stop solution to bootstrap Python projects, including essentials like Git and a virtual environment.

Background

Rollout was made to learn more about CLIs and how to make them using Python. If you...

  • ...want a simple project maker without any fancy bells or whistles, this is the place.
  • ...want customisable project templates and a rich ecosystem of them, use Cookiecutter or Copier.
  • ...have Node.js installed or want an alternative to Cookiecutter, you can use generator-python, a project generator built with Yeoman.
  • ...have Git installed and use high-level Python tools like tox, use skeleton.
  • ...want advanced dependency management, use the myriad tools out there like Poetry, pipenv, or PDM.

Install

Caution

This is still a work in progress. Use at your own risk!

Ensure that you have Python 3.10 or above.

Usage

pipenv run python rollout my-new-project -d numpy pandas matplotlib 

# If you didn't install with pipenv:
.venv/Scripts/Activate.ps1
python rollout my-new-project -d numpy pandas matplotlib 

Contributing

git clone https://github.com/AbsoluteRich/Rollout.git  # Or, if you have GitHub Desktop, clone the repository through that
pipenv install -d  # If you have pipenv installed. If not...

python -m venv .venv
.venv/Scripts/Activate.ps1
pip install -r requirements-dev.txt

Licence

This project is licenced under GPL-3.0.

About

Rollout is your one-stop solution to bootstrap Python projects, including essentials like Git and a virtual environment.

Resources

License

Stars

Watchers

Forks

Languages