Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

A tool to create and maintain your python projects

Project description

Project Organization and Creation (pocr)

Anaconda-Server Badge PyPI version

pocr is a project creation and management tool for python and git. It creates a conda environment and a github repository based on your requirements.

Requirements

You can use the base conda to install pocr.

conda config --set auto_activate_base true

Installation

You have three different options to install pocr. Just always keep in mind that the python version need to be > 3.5.

Uninstallation

If you have to re-install pocr:

  1. Delete the access token from your github page (Settings -> Developer settings -> Personal access tokens -> delete (pocr)
  2. rm -rf ~/.pocr
  3. pip3/pip/conda uninstall pocr

pip

If your pip path is pointing to the pip3 you can also you just pip.

pip3 install pocr

Then execute the command

pocr --install

and follow the instructions.

conda

conda install -c ecrop pocr

Then execute the command

pocr --install

and follow the instructions.

github

  1. Download the sourcecode from github.
  2. Move into the pocr root directory (folder which contains the setup.py file) cd pocr
  3. Install it pip install .

Then execute the command

pocr --install

and follow the instructions.

Usage

usage: pocr [-h] [--install] [--test] [--clear] {create,list,remove} ...

Project creation (pocr) command line tool

positional arguments:
  {create,list,remove}  The different functions of pocr
    create              Create a new pocr project
    list                Lists all existing pocr projects
    remove              Remove a pocr project

optional arguments:
  -h, --help            show this help message and exit
  --install             Start the installation wizard.
  --test                Puts pocr into testing mode
  --clear               Clears all user files

Create

To create a new project you can use the create command. The minimum requirements is the -n parameter to give the project a name. You can also lik the project with already existing conda environments or github repos.

CARE: The -gh, --git-hook command is in beta. This command exports before each git commit the conda environment.

usage: pocr create [-h] -n PROJECT_NAME [-p PYTHON_VERSION] [-r REPO_NAME]
                   [-c CONDA_NAME] [-gh]

optional arguments:
  -h, --help            show this help message and exit
  -n PROJECT_NAME, --project-name PROJECT_NAME
                        Name of the project
  -p PYTHON_VERSION, --python-version PYTHON_VERSION
                        Python version for the project. Default: 3.5
  -r REPO_NAME, --repo-name REPO_NAME
                        If you already have a github repo for the project.
                        Enter the repo name.
  -c CONDA_NAME, --conda-name CONDA_NAME
                        If you already have a conda environment for the
                        project. Enter the name.
  -gh, --git-hook       Install a pre-commit git hook which updates the conda
                        environment file before you commit

List

This command lists all the pocr project with some additional information.

usage: pocr list [-h]

optional arguments:
  -h, --help  show this help message and exit

Remove

After some time you want to remove a project from your system. This you can do with the remove command. The remove command with out additional options will just delete the pocr project from the system but not the files, environment or the repository. If you want to remove the the files, environment or repository use the below shown parameters.

usage: pocr remove [-h] -n NAME [-r] [-c] [-f] [-a]

optional arguments:
  -h, --help            show this help message and exit
  -n NAME, --name NAME  Name of the pocr project to remove
  -r, --repo            Also removes the remote repository
  -c, --conda           Also removes the conda environment from the system
  -f, --folder          Also removes the local folder
  -a, --remove-all      Remove everything (repo, folder, conda)

TODO

  • [ ] Finish git hook
  • [ ] Create repo with template
  • [ ] Create conda Dockerfile
  • [ ] Automatically connect github with dockerhub for automatic build

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pocr, version 0.1.5
Filename, size File type Python version Upload date Hashes
Filename, size pocr-0.1.5-py3-none-any.whl (13.8 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size pocr-0.1.5.tar.gz (9.4 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page