Skip to content

Commit

Permalink
Clean up setup (#146)
Browse files Browse the repository at this point in the history
* clean up setup.py

* update pre-commit

* removed unsued tox.ini and .editorconfig

* updated badges

* update readme

* update readthedocs.yml
  • Loading branch information
cehbrecht authored Nov 10, 2023
1 parent e900790 commit 8ce0be4
Show file tree
Hide file tree
Showing 6 changed files with 34 additions and 91 deletions.
21 changes: 0 additions & 21 deletions .editorconfig

This file was deleted.

2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
default_language_version:
python: python3.6
python: python3.9

repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
Expand Down
28 changes: 14 additions & 14 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,23 @@ version: 2
# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/source/conf.py
# fail_on_warning might generate hard to fix error, in this case it can be
# disabled but this also means those errors will fail silently, choose wisely.
fail_on_warning: false

# Build documentation with MkDocs
#mkdocs:
# configuration: mkdocs.yml

# Optionally build your docs in additional formats such as PDF and ePub
formats: all
# formats:
# - pdf

# Optionally set the version of Python and requirements required to build your docs
#python:
# version: 3.6
build:
os: ubuntu-22.04
tools:
python: "mambaforge-22.9"

conda:
environment: docs/environment.yml
environment: environment.yml

build:
image: stable
# Optionally set the version of Python and requirements required to build your docs
python:
install:
- method: pip
path: .
extra_requirements:
- docs
29 changes: 17 additions & 12 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,7 @@
rooki
=====

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

.. image:: https://github.com/roocs/rooki/workflows/build/badge.svg
:target: https://github.com/roocs/rooki/actions
:alt: Build Status

.. image:: https://img.shields.io/github/license/roocs/rooki.svg
:target: https://github.com/roocs/rooki/blob/master/LICENSE
:alt: GitHub license
|pypi| |conda| |build| |black|


Rooki is a client for roocs_ climate data operations service (rook_).
Expand All @@ -22,7 +12,6 @@ the rook_ WPS.

A Jupyter Notebook is provided to demonstrate the basic use of rooki.

Full documentation_ is on ReadTheDocs.

Online Demo
-----------
Expand Down Expand Up @@ -50,3 +39,19 @@ This package was created with Cookiecutter_ and the `cookiecutter-pypackage`_ pr
.. _roocs: https://github.com/roocs
.. _rook: https://github.com/roocs/rook
.. _documentation: https://rooki.readthedocs.io/en/latest/

.. |pypi| image:: https://img.shields.io/pypi/v/rooki.svg
:target: https://pypi.python.org/pypi/rooki
:alt: PyPI

.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/rooki.svg
:target: https://anaconda.org/conda-forge/rooki
:alt: Conda Forge

.. |build| image:: https://github.com/roocs/rooki/workflows/build/badge.svg
:target: https://github.com/roocs/rooki/actions
:alt: Build Status

.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/python/black
:alt: Black
18 changes: 2 additions & 16 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

__author__ = "Carsten Ehbrecht"
__contact__ = "[email protected]"
__copyright__ = "Copyright 2018 United Kingdom Research and Innovation"
__copyright__ = "Copyright 2023 United Kingdom Research and Innovation"
__license__ = "BSD - see LICENSE file in top-level package directory"
__version__ = "0.6.0"

Expand All @@ -29,10 +29,6 @@
"pytest",
]

setup_requirements = [
"pytest-runner",
]


setup(
author=__author__,
Expand All @@ -45,7 +41,6 @@
"Environment :: Web Environment",
"Intended Audience :: End Users/Desktop",
"Intended Audience :: Developers",
"Intended Audience :: System Administrators",
"Intended Audience :: Science/Research",
"License :: OSI Approved :: BSD License",
"Natural Language :: English",
Expand All @@ -60,30 +55,21 @@
"Topic :: Internet",
"Topic :: Scientific/Engineering",
"Topic :: System :: Distributed Computing",
"Topic :: System :: Systems Administration :: Authentication/Directory",
"Topic :: Software Development :: Libraries :: Python Modules",
],
description="A client for roocs climate data operations service.",
license=__license__,
# This qualifier can be used to selectively exclude Python versions -
# in this case early Python 2 and 3 releases
# This qualifier can be used to selectively exclude Python versions
python_requires=">=3.9.0",
entry_points={
"console_scripts": [
"rooki=rooki.cli:main",
],
},
install_requires=[
requirements,
# "pymetalink @ git+https://github.com/metalink-dev/pymetalink.git",
],
long_description=_long_description,
long_description_content_type="text/x-rst",
include_package_data=True,
keywords="rooki",
name="rooki",
packages=find_packages(include=["rooki"]),
setup_requires=setup_requirements,
test_suite="tests",
tests_require=test_requirements,
url="https://github.com/roocs/rooki",
Expand Down
27 changes: 0 additions & 27 deletions tox.ini

This file was deleted.

0 comments on commit 8ce0be4

Please sign in to comment.