From 0e24a94ad354a1603d1f8f5654fbd288e2bcef2b Mon Sep 17 00:00:00 2001
From: Scott Henderson <scottyhq@gmail.com>
Date: Sat, 7 Dec 2024 15:54:27 +0100
Subject: [PATCH] prepare first pypi release

---
 .github/CONTRIBUTING.md  | 90 +---------------------------------------
 .github/workflows/cd.yml |  8 ++--
 2 files changed, 6 insertions(+), 92 deletions(-)

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index c5a2212..6d035c9 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -1,89 +1,3 @@
-See the [Scientific Python Developer Guide][spc-dev-intro] for a detailed
-description of best practices for developing scientific packages.
+Contributions are welcome, please see our documentation:
 
-[spc-dev-intro]: https://learn.scientific-python.org/development/
-
-# Quick development
-
-The fastest way to start with development is to use nox. If you don't have nox,
-you can use `pipx run nox` to run it without installing, or `pipx install nox`.
-If you don't have pipx (pip for applications), then you can install with
-`pip install pipx` (the only case were installing an application with regular
-pip is reasonable). If you use macOS, then pipx and nox are both in brew, use
-`brew install pipx nox`.
-
-To use, run `nox`. This will lint and test using every installed version of
-Python on your system, skipping ones that are not installed. You can also run
-specific jobs:
-
-```console
-$ nox -s lint  # Lint only
-$ nox -s tests  # Python tests
-$ nox -s docs -- --serve  # Build and serve the docs
-$ nox -s build  # Make an SDist and wheel
-```
-
-Nox handles everything for you, including setting up an temporary virtual
-environment for each run.
-
-# Setting up a development environment manually
-
-You can set up a development environment by running:
-
-```bash
-python3 -m venv .venv
-source ./.venv/bin/activate
-pip install -v -e .[dev]
-```
-
-If you have the
-[Python Launcher for Unix](https://github.com/brettcannon/python-launcher), you
-can instead do:
-
-```bash
-py -m venv .venv
-py -m install -v -e .[dev]
-```
-
-# Pre-commit
-
-You should prepare pre-commit, which will help you by checking that commits pass
-required checks:
-
-```bash
-pip install pre-commit # or brew install pre-commit on macOS
-pre-commit install # Will install a pre-commit hook into the git repo
-```
-
-You can also/alternatively run `pre-commit run` (changes only) or
-`pre-commit run --all-files` to check even without installing the hook.
-
-# Testing
-
-Use pytest to run the unit checks:
-
-```bash
-pytest
-```
-
-# Coverage
-
-Use pytest-cov to generate coverage reports:
-
-```bash
-pytest --cov=coincident
-```
-
-# Building docs
-
-You can build the docs using:
-
-```bash
-nox -s docs
-```
-
-You can see a preview with:
-
-```bash
-nox -s docs -- --serve
-```
+https://coincident.readthedocs.io/en/latest/user_guide/contribute.html
diff --git a/.github/workflows/cd.yml b/.github/workflows/cd.yml
index 9ac0213..6bb09b8 100644
--- a/.github/workflows/cd.yml
+++ b/.github/workflows/cd.yml
@@ -55,7 +55,7 @@ jobs:
           subject-path: "dist/*"
 
       - uses: pypa/gh-action-pypi-publish@release/v1
-        with:
-          # Remember to tell (test-)pypi about this repo before publishing
-          # Remove this line to publish to PyPI
-          repository-url: https://test.pypi.org/legacy/
+        #with:
+        # Remember to tell (test-)pypi about this repo before publishing
+        # Remove this line to publish to PyPI
+        #repository-url: https://test.pypi.org/legacy/