Skip to content

Latest commit

 

History

History
223 lines (170 loc) · 7.1 KB

README.md

File metadata and controls

223 lines (170 loc) · 7.1 KB
Raw

psp (Python Scaffolding Projects)

psp is a blazing fast command line utility to scaffold your Python project, written in Rust.

  • ⚡️ 10-100x faster
  • 🛠️ pyproject.toml support
  • 🤝 Python 3.13 compatibility
  • 🗃 Scaffolding file and folder structures for your Python project
  • 📦 Unit-test and pytest supports
  • 🧪 Create virtual environment
  • 🔧 Automatically dependencies installation
  • 🪛 Add build and deploy dependencies to distribute package
  • 📏 tox configuration supports and remotes CI like CircleCI and TravisCI
  • ⌨️ MkDocs and Sphinx documentation supports
  • 🧰 Initialize git repository and gitignore file
  • 🌎 Github and Gitlab remote repository supports
  • 📑 Create README, LICENSE, CONTRIBUTING, CODE_OF_CONDUCT and CHANGES files
  • 🐳 Create Dockerfile and Containerfile for your project
  • 💡 Can use quick, simple and full argument for rapid configuration

psp

The result is:

$> tree test/ --filelimit=19 -a
test                    # Project folder
├── LICENSE.md          # License file
├── pyproject.toml      # Python package configuration file
├── README.md           # Readme file
├── CHANGES.md          # List of changes
├── .circleci           # CI folder
│   └── config.yml      # CI configuration file
├── CODE_OF_CONDUCT.md  # Code of Conduct
├── CONTRIBUTING.md     # Contributing guide lines
├── Containerfile       # Standard container file for build image
├── Dockerfile          # Docker container file for build image
├── Makefile            # Makefile for command make; make help
├── requirements.txt    # Dependencies list used by third programs
├── docs                # Documentation folder: Sphinx/MKDocs
│   ├── build
│   ├── make.bat
│   ├── Makefile
│   └── source
│       ├── conf.py
│       ├── index.rst
│       ├── _static
│       └── _templates
├── .git                # Git folder
│   ├── branches
│   ├── config
│   ├── description
│   ├── HEAD
│   ├── hooks  [14 entries exceeds filelimit, not opening dir]
│   ├── info
│   │   └── exclude
│   ├── objects
│   │   ├── info
│   │   └── pack
│   └── refs
│       ├── heads
│       └── tags
├── .github             # Github issue and merge templates
│   ├── ISSUE_TEMPLATE
│   │   ├── bug.yml
│   │   ├── config.yml
│   │   └── feature.yml
│   └── PULL_REQUEST_TEMPLATE
│       └── pull_request_template.md
├── .gitignore          # Git ignore file
├── test                # Python package
│   └── __init__.py
├── tests               # Tests package for modules
│   ├── __init__.py
│   └── test_test.py    # Test module "test_<name_python_package>"
├── tox.ini             # Tox configuration files
└── venv                # Virtual environment
    ├── bin  [33 entries exceeds filelimit, not opening dir]
    ├── include
    │   └── python3.13
    ├── lib
    │   └── python3.13
    │       └── site-packages  [68 entries exceeds filelimit, not opening dir]
    ├── lib64 -> lib
    └── pyvenv.cfg

29 directories, 44 files

And git status is:

$> git status
On branch main

No commits yet
...
$> git remote get-url origin
[email protected]:MatteoGuadrini/test.git

Prerequisites

psp has four prerequisetes installed on own machine:

  • git
  • python3
  • pip
  • curl

Ubuntu prerequisites installation

sudo apt install -y python3 python3-pip git curl

Red Hat prerequisites installation

sudo dnf install -y python3 python3-pip git curl

Arch prerequisites installation

sudo pacman -Qi python3 python3-pip git curl

Installation

To install compiled file into your machine, download it:

Linux

For all users:

sudo -i
curl -L https://github.com/MatteoGuadrini/psp/releases/download/v0.1.0/psp_linux > /usr/bin/psp
chmod +x /usr/bin/psp

For current user:

curl -L https://github.com/MatteoGuadrini/psp/releases/download/v0.1.0/psp_linux > $HOME/.local/bin/psp
chmod +x $HOME/.local/bin/psp

MacOS

sudo su -
curl -L https://github.com/MatteoGuadrini/psp/releases/download/v0.1.0/psp_macos > /usr/bin/psp
chmod +x /usr/bin/psp

Packages

If you want install OS package, follow instructions for your Operating System:

For Debian/Ubuntu:

curl -L https://github.com/MatteoGuadrini/psp/releases/download/v0.1.0/psp.deb
sudo dpkg -i psp.deb

For Fedora/Mageia/OpenSuse:

sudo rpm -i https://github.com/MatteoGuadrini/psp/releases/download/v0.1.0/psp.rpm

Compile as your own

Instead, if you compile this project as own, follow this steps:

git clone https://github.com/MatteoGuadrini/psp.git
cd psp && cargo build --release && sudo cp -var target/release/psp /usr/bin/psp

Open source

psp is an open source project. Any contribute, It's welcome.

A great thanks.

For donations, press this

For me

paypal

For Telethon

The Telethon Foundation is a non-profit organization recognized by the Ministry of University and Scientific and Technological Research. They were born in 1990 to respond to the appeal of patients suffering from rare diseases. Come today, we are organized to dare to listen to them and answers, every day of the year.

Adopt the future

Treeware

This package is Treeware. If you use it in production, then we ask that you buy the world a tree to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.

Treeware

Acknowledgments

Thanks to Jim Blandy, Jason Orendorff and Nora Tindall for writing the Programming Rust book that make up my Rust foundation.

Thanks to Tim McNamara for writing the Rust in Action book.

Thanks to Zed IDE and for license of RustRover offered by Jetbrains.

Special thanks go to my wife, who understood the hours of absence for this development. Thanks to my children, for the daily inspiration they give me and to make me realize, that life must be simple.

Thanks, Rust Community!