diff --git a/README.rst b/README.rst index 23e0a6c..9d8d1e5 100644 --- a/README.rst +++ b/README.rst @@ -3,14 +3,12 @@ FastCS |code_ci| |docs_ci| |coverage| |pypi_version| |license| -.. note:: +FastCS is a control system agnostic framework for building Device support in +Python that will work for both EPICS and Tango without depending on either. - This project contains template code only. For documentation on how to - adopt this skeleton project see - https://DiamondLightSource.github.io/FastCS-cli +.. note:: -This is where you should write a short paragraph that describes what your module does, -how it does it, and why people should use it. + This repository is in an early stage of development, and doesn't currently do the above! ============== ============================================================== PyPI ``pip install FastCS`` @@ -19,20 +17,6 @@ Documentation https://DiamondLightSource.github.io/FastCS Releases https://github.com/DiamondLightSource/FastCS/releases ============== ============================================================== -This is where you should put some images or code snippets that illustrate -some relevant examples. If it is a library then you might put some -introductory code here: - -.. code-block:: python - - from fastcs import __version__ - - print(f"Hello fastcs {__version__}") - -Or if it is a commandline tool then you might put some example commands here:: - - $ python -m fastcs --version - .. |code_ci| image:: https://github.com/DiamondLightSource/FastCS/actions/workflows/code.yml/badge.svg?branch=main :target: https://github.com/DiamondLightSource/FastCS/actions/workflows/code.yml :alt: Code CI diff --git a/docs/conf.py b/docs/conf.py index d3d4aad..cb2cab2 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -191,5 +191,5 @@ html_show_copyright = False # Logo -html_logo = "images/dls-logo.svg" -html_favicon = "images/dls-favicon.ico" +html_logo = "images/fastcs.svg" +html_favicon = "images/fastcs.svg" diff --git a/docs/images/dls-favicon.ico b/docs/images/dls-favicon.ico deleted file mode 100644 index 9a11f50..0000000 Binary files a/docs/images/dls-favicon.ico and /dev/null differ diff --git a/docs/images/dls-logo.svg b/docs/images/dls-logo.svg deleted file mode 100644 index 0af1a17..0000000 --- a/docs/images/dls-logo.svg +++ /dev/null @@ -1,11 +0,0 @@ - - - - - - - - - - - \ No newline at end of file diff --git a/docs/images/fastcs.svg b/docs/images/fastcs.svg new file mode 100644 index 0000000..6b35413 --- /dev/null +++ b/docs/images/fastcs.svg @@ -0,0 +1,384 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + diff --git a/pyproject.toml b/pyproject.toml index 484a6f7..d546900 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,7 +3,7 @@ requires = ["setuptools>=64", "setuptools_scm[toml]>=6.2", "wheel"] build-backend = "setuptools.build_meta" [project] -name = "FastCS" +name = "fastcs" classifiers = [ "Development Status :: 3 - Alpha", "License :: OSI Approved :: Apache Software License", @@ -13,7 +13,7 @@ classifiers = [ "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", ] -description = "One line description of your module" +description = "Control system agnostic framework for building Device support in Python that will work for both EPICS and Tango" dependencies = [ "typing-extensions;python_version<'3.8'", ] # Add project dependencies here, e.g. ["click", "numpy"] diff --git a/tests/test_boilerplate_removed.py b/tests/test_boilerplate_removed.py index a0675d9..6904120 100644 --- a/tests/test_boilerplate_removed.py +++ b/tests/test_boilerplate_removed.py @@ -2,14 +2,8 @@ This file checks that all the example boilerplate text has been removed. It can be deleted when all the contained tests pass """ -import sys from pathlib import Path -if sys.version_info < (3, 8): - from importlib_metadata import metadata # noqa -else: - from importlib.metadata import metadata # noqa - ROOT = Path(__file__).parent.parent @@ -31,11 +25,10 @@ def assert_not_contains_text(path: str, text: str, explanation: str): # pyproject.toml def test_module_summary(): - summary = metadata("python3-pip-skeleton")["summary"] - skeleton_check( - "One line description of your module" in summary, - "Please change project.description in ./pyproject.toml " - "to be a one line description of your module", + assert_not_contains_text( + "pyproject.toml", + "One line description of your module", + "so [project] description is a one line description of your module", )