Skip to content

Commit

Permalink
Merge pull request #393 from simonsobs/koopman/repo-cleanup
Browse files Browse the repository at this point in the history
Organize badges, define supported Python versions, and update versioneer
  • Loading branch information
BrianJKoopman authored Jul 30, 2024
2 parents 3909484 + 10ec779 commit 61f9170
Show file tree
Hide file tree
Showing 7 changed files with 1,064 additions and 438 deletions.
1 change: 1 addition & 0 deletions .flake8
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,6 @@ in-place = true
recursive = true
aggressive = 2
exclude =
ocs/_version.py,
versioneer.py,
docs/conf.py,
53 changes: 32 additions & 21 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,8 @@
OCS - Observatory Control System
================================

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

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

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

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

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

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

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


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

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

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

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

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

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

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

.. |versions| image:: https://img.shields.io/pypi/pyversions/ocs
:alt: PyPI - Python Version
5 changes: 2 additions & 3 deletions ocs/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,5 @@

from . import site_config # noqa: F401

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

0 comments on commit 61f9170

Please sign in to comment.