From 5692e57e62fb532a9f6a1037e42e075fe4f3d036 Mon Sep 17 00:00:00 2001 From: Lorenzo Bolla Date: Sun, 5 Jan 2025 17:30:48 +0100 Subject: [PATCH] Update README and Makefile --- Makefile | 3 +++ README.rst | 24 ++++++++++++++++++------ 2 files changed, 21 insertions(+), 6 deletions(-) diff --git a/Makefile b/Makefile index 9135e33..aa6e04b 100644 --- a/Makefile +++ b/Makefile @@ -10,6 +10,9 @@ REQUIREMENTS = requirements.txt requirements_dev.txt help: ## Print this help @grep -E '^[a-zA-Z][a-zA-Z0-9_-]*:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' +venv: ## Create venv for EMpy + mkvirtualenv EMpy + develop: upgrade-dev requirements-install ## Install project for development pip install -e . diff --git a/README.rst b/README.rst index a9b8d9f..b7a5ccc 100644 --- a/README.rst +++ b/README.rst @@ -31,25 +31,37 @@ Optionally, install `bvp`: Development =========== -First, download the source code from https://github.com/lbolla/EMpy. Then, from inside a `virtualenv`, install with: +First, download the source code from https://github.com/lbolla/EMpy. + +Create a virtualenv with, e.g: + +.. code-block:: bash + + $> make venv + +Then, from inside a `virtualenv`, install dev environment with: .. code-block:: bash - $> pip install -r requirements_dev.txt - $> python setup.py develop + $> make develop Run tests with: .. code-block:: bash - $> python setup.py test +Upgrade dependencies with: + +.. code-block:: bash + + $> make requirements-upgrade + $> make requirements-sync + Release process =============== 1. Edit CHANGES -2. `bumpversion major|minor|patch` -3. `git push && git push --tags` +2. `make release PART=major|minor|patch` Citation ========