Skip to content

Commit

Permalink
Organize badges, define supported Python versions, and update version…
Browse files Browse the repository at this point in the history
…eer (#673)

* Cleanup badges in README

* Add python versions to classifiers list

* Update versioneer to version 0.29

* Remove lingering references to socs_version.py
  • Loading branch information
BrianJKoopman authored May 21, 2024
1 parent 1760a7a commit f82bcf0
Show file tree
Hide file tree
Showing 10 changed files with 1,065 additions and 958 deletions.
1 change: 1 addition & 0 deletions .flake8
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ exclude =
socs/mibs/IBOOTPDU-MIB.py,
socs/mibs/UPS-MIB.py,
socs/mibs/MBG-SYNCBOX-N2X-MIB.py,
socs/_version.py,
versioneer.py,
docs/conf.py,
per-file-ignores =
Expand Down
1 change: 0 additions & 1 deletion .gitattributes
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
socs_version.py export-subst
socs/_version.py export-subst
53 changes: 32 additions & 21 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,8 @@
SOCS - Simons Observatory Control System
========================================

.. image:: https://img.shields.io/github/actions/workflow/status/simonsobs/socs/develop.yml?branch=main
:target: https://github.com/simonsobs/socs/actions?query=workflow%3A%22Build+Test+Images%22
:alt: GitHub Workflow Status

.. image:: https://readthedocs.org/projects/socs/badge/?version=main
:target: https://socs.readthedocs.io/en/main/?badge=main
:alt: Documentation Status

.. image:: https://coveralls.io/repos/github/simonsobs/socs/badge.svg
:target: https://coveralls.io/github/simonsobs/socs

.. image:: https://img.shields.io/badge/dockerhub-latest-blue
:target: https://hub.docker.com/r/simonsobs/socs

.. image:: https://img.shields.io/pypi/v/socs
:target: https://pypi.org/project/socs/
:alt: PyPI Package

.. image:: https://results.pre-commit.ci/badge/github/simonsobs/socs/main.svg
:target: https://results.pre-commit.ci/latest/github/simonsobs/socs/main
:alt: pre-commit.ci status
| |pypi| |versions| |docker| |license|
| |tests| |pre-commit| |coverage| |docs|
Overview
--------
Expand Down Expand Up @@ -142,3 +123,33 @@ This project is licensed under the BSD 2-Clause License - see the
`LICENSE.txt`_ file for details.

.. _LICENSE.txt: https://github.com/simonsobs/socs/blob/main/LICENSE.txt


.. |coverage| image:: https://coveralls.io/repos/github/simonsobs/socs/badge.svg
:target: https://coveralls.io/github/simonsobs/socs

.. |docker| image:: https://img.shields.io/badge/dockerhub-latest-blue
:target: https://hub.docker.com/r/simonsobs/socs

.. |docs| image:: https://readthedocs.org/projects/socs/badge/?version=main
:target: https://socs.readthedocs.io/en/main/?badge=main
:alt: Documentation Status

.. |license| image:: https://img.shields.io/pypi/l/socs
:target: LICENSE.txt
:alt: PyPI - License

.. |pre-commit| image:: https://results.pre-commit.ci/badge/github/simonsobs/socs/main.svg
:target: https://results.pre-commit.ci/latest/github/simonsobs/socs/main
:alt: pre-commit.ci status

.. |pypi| image:: https://img.shields.io/pypi/v/socs
:target: https://pypi.org/project/socs/
:alt: PyPI Package

.. |tests| image:: https://github.com/simonsobs/socs/actions/workflows/pytest.yml/badge.svg
:target: https://github.com/simonsobs/socs/actions/workflows/pytest.yml
:alt: GitHub Workflow Status

.. |versions| image:: https://img.shields.io/pypi/pyversions/socs
:alt: PyPI - Python Version
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
import sys

sys.path.insert(0, os.path.abspath('..'))
from socs_version import get_versions
from socs._version import get_versions

# -- Project information -----------------------------------------------------

Expand Down
3 changes: 3 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,6 @@ requires = [
"versioneer-518",
]
build-backend = "setuptools.build_meta"

[tool.isort]
skip = ["versioneer.py", "socs/_version.py"]
5 changes: 5 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,11 @@
},
classifiers=[
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"License :: OSI Approved :: BSD License",
"Intended Audience :: Science/Research",
"Topic :: Scientific/Engineering :: Astronomy",
Expand Down
6 changes: 2 additions & 4 deletions socs/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
from . import _version

from ._version import get_versions

__version__ = get_versions()['version']
del get_versions
__version__ = _version.get_versions()['version']
Loading

0 comments on commit f82bcf0

Please sign in to comment.