Skip to content

pschwllr/minimal_project

Repository files navigation

Project Logo

Coverage Status

ch200


Just a short project test

🔥 Usage

TODO show in a very small amount of space the MOST useful thing your package can do. Make it as short as possible! You have an entire set of docs for later.

👩‍💻 Installation

Create a new environment, you may also give the environment a different name.

conda create -n ch200 python=3.10 
conda activate ch200

If you need jupyter lab, install it

(ch200) $ pip install jupyterlab

🛠️ Development installation

Initialize Git (only for the first time).

Note: You should have create an empty repository on https://github.com:pschwllr/ch200.

git init
git add * 
git add .*
git commit -m "Initial commit" 
git branch -M main
git remote add origin git@github.com:pschwllr/ch200.git 
git push -u origin main

Then add and commit changes as usual.

To install the package, run

(ch200) $ pip install -e ".[test,doc]"

Run tests and coverage

(conda_env) $ pip install tox
(conda_env) $ tox

Generate coverage badge

Works after running tox

(conda_env) $ pip install "genbadge[coverage]"
(conda_env) $ genbadge coverage -i coverage.xml

Generated with some inspiration from cookiecutter-snekpack and copier-pylib.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages