https://github.com/dumbmachine/projectpy
A Simple "create-react-app" like CLI tool to create Python Project File Structure.
https://github.com/dumbmachine/projectpy
cli pypi python simple
Last synced: about 1 year ago
JSON representation
A Simple "create-react-app" like CLI tool to create Python Project File Structure.
- Host: GitHub
- URL: https://github.com/dumbmachine/projectpy
- Owner: DumbMachine
- License: bsd-2-clause
- Created: 2019-05-29T19:07:54.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-06-29T18:50:28.000Z (almost 7 years ago)
- Last Synced: 2024-08-09T09:44:23.936Z (over 1 year ago)
- Topics: cli, pypi, python, simple
- Language: Python
- Homepage: https://dumbmachine.github.io/ProjectPy
- Size: 377 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](http://hits.dwyl.io/DumbMachine/projectpy)
[](https://pepy.tech/project/projectpy)
[](https://ci.appveyor.com/project/DumbMachine/create-python-project) [](https://travis-ci.org/DumbMachine/ProjectPy) [](https://codeclimate.com/github/DumbMachine/create-python-project/maintainability) [](https://snyk.io/test/github/DumbMachine/create-python-project?targetFile=requirements.txt)
## Getting Started:
A Simple **create-react-app** like CLI tool to create Python Package File Structure.
It offers the current features:
* Super Easy to use cli.
* One Command installation for Simple Python Packages.
* Customizable config for awesome Python Packages.
* Minimal worries about project structure.
* No dependencies.
## Installation
### Install from PyPI:
```bash
$ pip install projectpy
```
### Install from Source:
* Clone this repository and install the package:
```bash
$ git clone https://github.com/DumbMachine/ProjectPy
$ cd projectpy
$ python setup.py install
```
## Basic Usage
Creating a simple Python Package with default settings is as simple as:
```bash
$ projectpy -n ExamplePackage
---------------------------------------------------------------------------------------
PROJECTPY: A Python CLI to create packages
Creating ExamplePackage with the following config:
project_name: ExamplePackage
project_version: 0.01
project_description: "This is the default Placeholder description"
author_name: "Placeholder:author_name"
github_username: "Placeholder:github_username"
github_email: "Placeholder:github_email"
license: "MIT"
git: True
color: True
requirements: True
readme: "markdown"
contributing.md: True
interactive: False
shields:
build: "appveyor"
chat: "discord"
license: "github"
extras: "pypi---downloads"
🌟 Done in 3 seconds.
✅ Success created Example_Repo in ~/Example_Repo
______________________________
| |
| Generation was successful |
| ------------------------- |
| $ cd ExamplePackage |
| $ python setup.py install |
------------------------------
👋 bai bai
```
This will create a directory **ExampleDirectory** with the following Tree structure:
```bash
$ tree ExamplePackage/
----------------------------------------------------------------------------------------
ExamplePackage
├── contributing.md
├── ExamplePackage
  └── __init__.py
├── LICENSE
├── MANIFEST.ini
├── README.md
├── requirements.txt
├── setup.py
└── tests
└── __init__.py
```
{% hint style="success" %}
The Package is now ready to be installed.
{% endhint %}
**To Install the package:**
```bash
$ cd ExamplePackage
$ python setup.py install
# To check the installation, try importing the installed package.
$ python
Python 3.7.3 (default, Mar 27 2019, 22:11:17)
[GCC 7.3.0] :: Anaconda, Inc. on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import ExamplePackage
🎉 Successfull Installation
```
# 🗒 TODO:
- [ ] Add support for Logging.
- [ ] Improve the CLI ( Add more colors ).
- [ ] Make examples for showing the thing.
- [ ] Add support for Jenkins.
- [ ] Check for COnda INstall Support.
- [ ] Add Support for Black/isort.
- [ ] Add support for Submodules.
- [ ] Format years and shizz in the LICENSES.
- [ ] Write up a function to generate Config template.
- [ ] Add option for presets.
- [ ] Data Science/ Kaggle
- [ ] Web
- [ ] Flask
- [ ] Django
- [ ]
- [ ] Add support to ignore .files and temp_*.py files for shizeles.
[](http://hits.dwyl.io/DumbMachine/projectpy) [](https://pepy.tech/project/projectpy)