Skip to content

Commit afd2339

Browse files
Update setup.py and update docs (#122)
* Update `setup.py` and remove MIT License refs - `setup.py` includes unnecessary and outdated configs * Update `README.md` badges * Remove license refs * Update project authors and contributors * Update docs on CI/CD
1 parent 7382204 commit afd2339

File tree

6 files changed

+24
-40
lines changed

6 files changed

+24
-40
lines changed

AUTHORS.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ Development Lead
1010
Contributors
1111
------------
1212

13-
None yet. Why not be the first?
13+
* Stephen Po-Chedley

README.rst

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,16 @@
11
XCDAT
22
=====
33

4-
|Anaconda-Server Badge| |CI/CD Build Workflow| |CI/CD Release Workflow| |docs|
5-
|Codecov|
4+
|CI/CD Build Workflow| |docs| |Codecov|
65

76
|pre-commit| |Code style: black| |flake8| |Checked with mypy|
87

98
Xarray Extended with Climate Data Analysis Tools
109

11-
- Free software: MIT license
1210
- Documentation: https://xcdat.readthedocs.io/en/latest/
1311

1412
.. |CI/CD Build Workflow| image:: https://github.com/XCDAT/xcdat/actions/workflows/build_workflow.yml/badge.svg
1513
:target: https://github.com/XCDAT/xcdat/actions/workflows/build_workflow.yml
16-
.. |CI/CD Release Workflow| image:: https://github.com/XCDAT/xcdat/actions/workflows/release_workflow.yml/badge.svg
17-
:target: https://github.com/XCDAT/xcdat/actions/workflows/release_workflow.yml
1814
.. |docs| image:: https://readthedocs.org/projects/xcdat/badge/?version=latest
1915
:target: https://xcdat.readthedocs.io/en/latest/?badge=latest
2016
.. |Codecov| image:: https://codecov.io/gh/XCDAT/xcdat/branch/main/graph/badge.svg?token=UYF6BAURTH

docs/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,8 @@
7575

7676
# General information about the project.
7777
project = "XCDAT"
78-
copyright = "2021, Tom Vo"
79-
author = "Tom Vo"
78+
copyright = "2021, XCDAT Developers"
79+
author = "XCDAT Developers"
8080

8181
# The version info for the project you're documenting, acts as replacement
8282
# for |version| and |release|, also used in various other places throughout

docs/index.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,3 @@ XCDAT: Xarray Extended with Climate Data Analysis Tools
3232
What’s New <history>
3333
Team <authors>
3434
GitHub Repository <https://github.com/XCDAT/xcdat>
35-
36-
License
37-
-------
38-
XCDAT is available under the open source `MIT License <https://github.com/XCDAT/xcdat/blob/main/LICENSE>`_.

docs/project_maintenance.rst

Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Releasing a New Version
1010
-----------------------
1111

1212
1. Add updates to HISTORY.rst
13-
2. Checkout the latest ``master``.
13+
2. Checkout the latest ``main`` branch.
1414
3. Checkout a branch with the name of the version.
1515

1616
::
@@ -28,26 +28,16 @@ Releasing a New Version
2828
tbump <version> --no-tag
2929

3030
5. Create a pull request to the main repo and merge it.
31-
6. Create a GitHub release. GitHub Actions will handle publishing the package to Anaconda.
31+
6. Create a GitHub release.
32+
7. Open a PR to the xcdat conda-forge feedstock with the latest changes.
3233

3334
Continuous Integration / Continuous Delivery (CI/CD)
3435
-----------------------------------------------------
3536

36-
This project uses `GitHub Actions <https://github.com/XCDAT/xcdat/actions>`_ to run two CI/CD workflows.
37+
This project uses `GitHub Actions <https://github.com/XCDAT/xcdat/actions>`_ to run the CI/CD build workflow.
3738

38-
1. CI/CD Build Workflow
39-
40-
This workflow is triggered by Git ``pull_request`` and ``push`` (merging PRs) events to the the main repo's ``master``.
41-
42-
Jobs:
39+
This workflow is triggered by Git ``pull_request`` and ``push`` (merging PRs) events to the the main repo's ``main`` branch.
4340

41+
Jobs:
4442
1. Run ``pre-commit`` for formatting, linting, and type checking
4543
2. Build conda development environment and run test suite
46-
47-
2. CI/CD Release Workflow
48-
49-
This workflow is triggered by the Git ``publish`` event, which occurs when a new release is tagged.
50-
51-
Jobs:
52-
53-
1. Publish Anaconda package

setup.py

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,23 @@
1313
history = history_file.read()
1414

1515
# https://packaging.python.org/discussions/install-requires-vs-requirements/#install-requires
16-
requirements: List[str] = ["xarray", "pandas", "numpy"]
17-
18-
setup_requirements: List[str] = []
19-
20-
test_requirements = ["pytest>=3"]
16+
install_requires: List[str] = [
17+
"cf_xarray",
18+
"dask",
19+
"numpy",
20+
"pandas",
21+
"xarray",
22+
"typing_extensions",
23+
]
24+
test_requires = ["pytest>=3"]
2125

2226
setup(
23-
author="Tom Vo",
24-
author_email="[email protected]",
27+
author="XCDAT developers",
2528
python_requires=">=3.5",
2629
classifiers=[
2730
"Development Status :: 2 - Pre-Alpha",
2831
"Intended Audience :: Developers",
29-
"License :: OSI Approved :: MIT License",
32+
"License :: OSI Approved :: Apache-2.0 License",
3033
"Natural Language :: English",
3134
"Programming Language :: Python :: 3",
3235
"Programming Language :: Python :: 3.5",
@@ -35,16 +38,15 @@
3538
"Programming Language :: Python :: 3.8",
3639
],
3740
description="Xarray Extended with Climate Data Analysis Tools",
38-
install_requires=requirements,
39-
license="MIT license",
41+
install_requires=install_requires,
42+
license="Apache-2.0",
4043
long_description=readme + "\n\n" + history,
4144
include_package_data=True,
4245
keywords="xcdat",
4346
name="xcdat",
4447
packages=find_packages(include=["xcdat", "xcdat.*"]),
45-
setup_requires=setup_requirements,
4648
test_suite="tests",
47-
tests_require=test_requirements,
49+
tests_require=test_requires,
4850
url="https://github.com/XCDAT/xcdat",
4951
version="0.1.0",
5052
zip_safe=False,

0 commit comments

Comments
 (0)