Skip to content

Commit

Permalink
MNT: Remove no-longer-needed setup.py
Browse files Browse the repository at this point in the history
Also update some docs around install, etc.
  • Loading branch information
dopplershift committed Nov 4, 2024
1 parent 6b9fe44 commit de984f9
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 46 deletions.
17 changes: 6 additions & 11 deletions docs/developerguide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,22 +66,17 @@ Testing
Unit tests are the lifeblood of the project, as it ensures that we can continue to add and
change the code and stay confident that things have not broken. Running the tests requires
``pytest``, which is easily available through ``conda`` or ``pip``. Running the tests can be
done via either:
done by:

.. parsed-literal::
python setup.py test
pytest tests
or

.. parsed-literal::
py.test
Using ``py.test`` also gives you the option of passing a path to the directory with tests to
This gives you the option of passing a path to the directory with tests to
run, which can speed running only the tests of interest when doing development. For instance,
to only run the tests in the ``siphon/cdmr`` directory, use:

.. parsed-literal::
py.test siphon/cdmr
pytest siphon/cdmr
----------
Code Style
Expand Down Expand Up @@ -142,7 +137,7 @@ To create a new release:
3. (optional) Perform a ``git clean -f -x -d`` from the root of the repository. This will
**delete** everything not tracked by git, but will also ensure clean source distribution.
``MANIFEST.in`` is set to include/exclude mostly correctly, but could miss some things.
4. Run ``python setup.py sdist bdist_wheel`` (this requires ``wheel`` is installed).
4. Run ``python -m build`` (this requires that ``build`` is installed).
5. Upload using ``twine``: ``twine upload dist/*``, assuming the ``dist/`` directory contains
only files for this release. This upload process will include any changes to the ``README``
as well as any updated flags from ``setup.py``.
as well as any updated flags from ``pyproject.toml``.
18 changes: 6 additions & 12 deletions docs/installguide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,10 @@ In general, Siphon tries to support minor versions of dependencies released with
years. For Python itself, that means supporting the last two minor releases.

Siphon currently supports the following versions of required dependencies:
- requests >= 1.2
- numpy >= 1.8.0
- protobuf >= 3.0.0
- beautifulsoup4>=4.6
- pandas

.. literalinclude:: ../../pyproject.toml
:start-at: beautifulsoup4
:end-at: requests

Installation Instructions for NumPy can be found at:
https://numpy.org/install/
Expand All @@ -27,12 +26,7 @@ The easiest way to install Siphon is through ``pip``:
.. parsed-literal::
pip install siphon
Siphon can also be installed through ``conda``:

.. parsed-literal::
conda install -c unidata siphon
Additionally, Siphon can be installed with ``conda-forge``:
Siphon can also be installed through ``conda``, using the ``conda-forge`` channel:

.. parsed-literal::
conda install -c conda-forge siphon
Expand All @@ -41,7 +35,7 @@ The source code can also be grabbed from `GitHub <https://github.com/Unidata/sip
the base of the source directory, run:

.. parsed-literal::
python setup.py install
pip install .
This will build and install Siphon into your current Python installation.

Expand Down
23 changes: 0 additions & 23 deletions setup.py

This file was deleted.

0 comments on commit de984f9

Please sign in to comment.