diff --git a/.github/workflows/publish-package.yml b/.github/workflows/publish-package.yml index b1c7e3f..c5724d2 100644 --- a/.github/workflows/publish-package.yml +++ b/.github/workflows/publish-package.yml @@ -22,6 +22,9 @@ jobs: run: | python -m pip install --upgrade pip setuptools wheel twine build + # Note, this is set up following this tutorial: + # https://packaging.python.org/en/latest/tutorials/packaging-projects/ + # This relies on the pyproject.toml file. - name: Build and publish run: | python -m build diff --git a/PyPI_Readme.md b/PyPI_Readme.md deleted file mode 100644 index 8f69eab..0000000 --- a/PyPI_Readme.md +++ /dev/null @@ -1,34 +0,0 @@ -# Enables you to build a CLI with python in the most straightforward way with the fewest lines of code: - -# Turn this: -``` -from CliFunction import cli_function, cli - -@cli_function -def migrate_data_base(*, start_version: int = 0, end_version: int = 3): - """ - Runs DB migrations. - """ - print(f"Migrating DB from {start_version} to {end_version}") - - -if __name__ == "__main__": - CliFunction.cli() -``` - -# Into a CLI with documentation like this: - -``` -C:\Users\isaak\dev\clifunction>python Example.py -Targets - migrate_data_base -- Runs DB migrations. - start_version | default:0 | type: - end_version | default:3 | type: -``` - -# With easy cli execution and type coercion like this: -``` -C:\Users\isaak\dev\clifunction>python Example.py mdb -sv=1 -ev=2 -migrate_data_base: {'start_version': 1, 'end_version': 2} -Migrating DB from 1 to 2 -``` \ No newline at end of file diff --git a/README.md b/README.md index f5689d5..ca1e1e0 100644 --- a/README.md +++ b/README.md @@ -7,4 +7,10 @@ Enables you to build a CLI with python in the most straightforward way with the https://isaak-malers.github.io/clifunction/#getting-started # Get it with PIP: -https://pypi.org/project/clifunction/ \ No newline at end of file +https://pypi.org/project/clifunction/ + +# Interested in Contributing?: +1. Create, or find an issue. All branches must be tied to a github issue. +2. Create a branch for your issue. It should be named after the issue number and with an optional description +3. Make and test feature/fix/change on the branch +4. Add Pull request for the branch, ensuring issue is linked so that reviewers have context for the changeset. diff --git a/developer.md b/developer.md deleted file mode 100644 index d3e0bd5..0000000 --- a/developer.md +++ /dev/null @@ -1,23 +0,0 @@ -# Contributing: - -This project uses trunk based development, but with an understanding that open source moves a little slower. Please following the following steps to contribute. - -Steps to Contribute: -1. Create, or find an issue. All branches must be tied to a github issue. -2. Create a branch for your issue. It should be named after the issue number and with an optional description -3. Make and test feature/fix/change on the branch -4. Add Pull request for the branch, ensuring issue is linked so that reviewers have context for the changeset. - -## Note: -this information condensed from: https://packaging.python.org/en/latest/tutorials/packaging-projects/ - -## Building - -to build dist. CD into the root repository directory: -```python -m build``` -this will create a "dist" directory with a wheel and a tar.gz file. - -## Publishing - -To publish (from windows) Note you must paste an access token for PyPi here: -```python -m twine upload -u __token__ -p [PUT PIPY TOKEN HERE] dist/*``` \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index ddeb539..78345b9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "hatchling.build" [project] name = "clifunction" -version = "0.2.2" +version = "0.2.3" authors = [ { name="Isaak Malers", email="isaak.malers+clifunction@gmail.com" }, ]