diff --git a/.github/workflows/main_release.yaml b/.github/workflows/release.yaml similarity index 96% rename from .github/workflows/main_release.yaml rename to .github/workflows/release.yaml index b156fb3..0faa34d 100644 --- a/.github/workflows/main_release.yaml +++ b/.github/workflows/release.yaml @@ -1,4 +1,4 @@ -name: 🐍 + 📦 => PyPI +name: 🐍 + 📦 on: workflow_run: diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml index ab94754..d2faba5 100644 --- a/.github/workflows/tests.yaml +++ b/.github/workflows/tests.yaml @@ -3,11 +3,9 @@ name: Tests on: push: branches: - - 'development' - 'main' pull_request: branches: - - 'development' - 'main' jobs: diff --git a/README.md b/README.md index 6671c34..9fd0005 100644 --- a/README.md +++ b/README.md @@ -10,24 +10,35 @@ This is a python-cli tool for interactive project setup, following best practice In order to assure easier distribution, the project is deployed as **pypi** package. For optimal maintenance the project utilizes the **tox** framework. -## Installation -We use `pip` for our package distribution, that's why we recomend that you use virtual environment for the package instalation (`venv` or `poetr`). +# Installation +We use `pip` for our package distribution, that's why we recommend that you use a virtual environment for the package installation (`venv` or `poetry`). ```bash -(env) pip install python-project-cli +pip install python-project-cli ``` ## Commands -- `python-cli generate` - starts interactive project generation, that uses cookiecutter. -- `python-cli status` - shows the framework repo status. We aim to update the main templates frequently, in order to keep up with the everevolving "best" practices, that's why there's a chance for a repo downtime. -- `python-cli version` - project version. +1. **generate**s a new project in interactive mode, usesing `cookiecutter`. + ```bash + python-cli generate + ``` + +2. Shows the framework repo **status**. We aim to update the main templates frequently, in order to keep up with the everevolving "best" practices, that's why there's a chance for a repo downtime. + ```bash + python-cli status + ``` + +3. Project's **version**. + ```bash + python-cli version + ``` ### Frameworks - Django - FastAPI - +### Project Maintenance (Internal) +[Confluence link](https://mentormate.atlassian.net/wiki/spaces/MMSDLC/pages/4325900953/Python+CLI+documentation) ## License - PYTHON-PROJECT-CLI is unlicensed, as found in the [LICENSE](https://github.com/MentorMate/python-project-cli/blob/development/LICENSE) file. diff --git a/pyproject.toml b/pyproject.toml index fe6417e..2905a1f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -32,9 +32,6 @@ version_variables = [ upload_to_pypi = true build_command = "pip install poetry && poetry build" -[tool.semantic_release.branches.development] -match = "development" - [tool.semantic_release.branches.main] match = "main"