-

djmannion · Feb 24, 2024 · 9e0ad92 · 9e0ad92
1 parent 85125a4
commit 9e0ad92
Show file tree

Hide file tree

Showing 6 changed files with 37 additions and 77 deletions.
diff --git a/.github/workflows/publish-to-test-pypi.yml b/.github/workflows/publish-to-test-pypi.yml
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,4 @@ __pycache__/
 *.pyo
 *egg-info
 build/
+dist/
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.2 (24/2/2024)
+
+* Initial release
diff --git a/README.md b/README.md
@@ -156,3 +156,29 @@ class Cortex(pympljstyle.BaseJournal):
 ```
 
 Once complete, consider contributing your new journal styles to the package via a pull request.
+
+
+## Development
+
+### Build and release process
+
+First, build the package (after having previously run `pip install -e .[build]`):
+
+```bash
+python -m build
+```
+
+This will produce files in the `dist/` sub-directory.
+
+Then, test the ability to upload to the test PyPI server:
+
+```bash
+python -m twine upload --repository testpypi dist/*
+```
+
+If that all looks OK, then upload to PyPI:
+
+```bash
+python -m twine twine upload dist/*
+```
+
diff --git a/pyproject.toml b/pyproject.toml
@@ -35,6 +35,10 @@ interactive = [
   "ipython",
   "pickleshare",
 ]
+build = [
+  "build",
+  "twine",
+]
 
 [project.urls]
 Documentation = "https://github.com/djmannion/pympljstyle#readme"

diff --git a/src/pympljstyle/__init__.py b/src/pympljstyle/__init__.py
@@ -1,4 +1,4 @@
-__version__ = "0.1"
+__version__ = "0.2"
 
 import pympljstyle.journals  # noqa: F401
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,3 +3,4 @@ __pycache__/ @@
     *.pyo
     *egg-info
     build/
+    dist/