Seb-sti1 / ProjectHub

A small software to manage my projects
GNU General Public License v3.0
1 stars 0 forks source link

ProjectHub

On master Run PyTest, build and publish Build and deploy documentations

On dev Run PyTest, build and publish Build and deploy documentations


A small software to manage my projects.

Development

To install the required dependencies, we recommend using a virtual environment.

Conda

If you use conda, you can start using the following commands:

conda create -n projecthub python=3.10 pip -y
conda activate projecthub
pip install -r requirements.txt

Venv

If you use venv, you can start using the following commands:

python3.10 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

Usage

Once the virtual environment has been activated, you can use the project without installing it by using the following command in the root directory:

python -m projecthub

Building

To build the package you need to run

python -m build

Then in the dist/ you will find the projecthub-$VERSION-py3-none-any.whl needed for the installation

Installation

Installation of pipx

You need to install pipx in order to run the project independently of the current loaded environment. Follow the steps in the given section of the official repository via this link, with pip

Installation of ProjectHub

For now there is no release on GitHub, you need to build and then using pipx install:

pipx install ./path/to/projecthub-$VERSION-py3-none-any.whl

To remove you can do

pipx uninstall projecthub