Usage¶

Example¶

Example how a project is created and pproject autoenv_toggle and pproject autoenv is used inside a project:

autoenv_toggle, autoupdate_toggle and autoenv¶

pproject autoenv_toggle
>> ℹ      AUTOACTIVATE off

pproject autoenv_toggle
>> ℹ      AUTOACTIVATE on

pproject autoupdate_toggle
>> ℹ      AUTOUPDATE off

pproject autoupdate_toggle
>> ℹ      AUTOUPDATE on

pproject autoenv

pproject create¶

If you use gitlab as your vcs and have set the use-groups-flag inside the config file, the available namespaces for your project creation are collected from the gitlab-instance as defined in the config-file using your token. These namespaces are your group-names minus your company-name.

For example:

Your company-name is “example”. Then all your groups have to start with “example-“. Valid would be for example: “example-testing”, “example-modules”, etc.

If not connection to your gitlab is possible, the offline namespaces as defined in the config-file are used.

The default setting for project creation is to create it local. In this case the created project will be n initialized git repository, but the remote-origin isn’t set. Only if the –remote flag is passed, it will also be created on your remote vcs and the origin-url of the project is automatically set. Then, after creation, all created files are added, commited and pushed to the remote.

pproject create [--remote] {NAMESPACES} -n PROJECTNAME [-p PYTHONVERSION]

pproject update¶

Creates a conda-environment based on the information inside the conda-build/meta.yaml-file. If the environment already exists it will be removed and recreated to pretend dependency zombies.

pproject update

pproject test¶

Uses pytest to run all tests inside the tests-folder.

pproject test

pytest_arguments:
    - '--cache-clear'
    - '-q'
    - '-s'

pproject version¶

If you use pproject for your project you have to use semantic versioning style for your projects versionnumber. This means your versionnumber is a combination of “majorversion.minorversion.patchversion”. For details about semantic versioning see https://semver.org/ for details.

pproject version -m "MESSAGE" {major, minor, patch}

pproject version -m "Changes in ..." major

pproject build¶

Creates a conda-package of your project with the current git tag (set with pproject version). First updates the environment using pproject update to use the latest project-conda-environment. Then pproject test is run to test if all tests of your project as defined in the tests-folder succeed. If there isn’t any uncommited stuff in your project and it is tagged, the conda-package is build and added to your local conda-build-folder. If you passed the flag –publish it will also be published to your conda-repository server as defined in your config-file.

Steps being run:

• updating environment
• testing your project else breaks
• checking for uncommited stuff in your project else breaks
• checking if git-tagged else breaks
• checking if git-tag also pushed to origin else breaks
• building conda-package
• (copying your package to the conda-repository server [OPTIONAL])

pproject build [--publish]

# ssh-connection-options to the conda-repository-server
conda_repo_userathost: 'user@host'

# path on the conda-repository-server where your conda-bld/linux-64
# folder is located
conda_repo_pkgs_path: '/var/repopath'

# path to your conda-executable
conda_repo_conda_bin: '/var/local/conda/bin/conda'

pproject info¶

The pproject info command is seperated into two commands:

• pproject info general
• pproject info project

pproject info general

pproject info general

pproject release¶

Releases your project as a conda-package in its own environment (environmentname: CONDAPACKAGENAME_env, if your don’t pass another environment-name using the -e-parameter) on the destination host (name passed with the -d parameter).

ssh-copy-id USERNAME@HOSTNAME

ssh-keygen -t rsa -b 4096 -C "YOUR_EMAIL"

Steps being run:

• updating environment.
• testing your project else breaks.
• checking for uncommited stuff in your project else breaks.
• checking if git-tagged else breaks.
• checking if git-tag also pushed to origin else breaks.
• building conda-package.
• copying your package to the conda-repository server.
• creating environment on destination host with created package installed inside (if already exists it is removed and replaced).
• add changes to destination-hosts ~/.pproject.log file for traceability.

pproject release -d USERNAME@HOSTNAME [-e ENVIRONMENT_NAME]

pproject sphinx¶

This command creates both a html- and a pdf-sphinx documentation of your project using the read-the-docs-theme. Please make sure to use the numpy- or google-documentation-style inside your code.

pproject sphinx

Resulting in two new folders:

• build
• source

Inside the source folder, the files on which the resulting documentations are based are stored. You can customize the inlcuding rst-files as you need. Running pproject sphinx again creates the resulting pdf- and html-files inside the build-folder.