summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeremy Stanley <fungi@yuggoth.org>2021-06-16 16:01:48 +0000
committerJeremy Stanley <fungi@yuggoth.org>2021-07-10 16:45:05 +0000
commitaa21a0c61b1b665714f5b6e55ec202db9ddc22f1 (patch)
tree7539d3430b98c440ef5d871266299a10aabeef0e
parent8e93a6b7b8d7df30521e745eb99c742715999646 (diff)
downloadgear-aa21a0c61b1b665714f5b6e55ec202db9ddc22f1.tar.gz
Overhaul package metadata and contributor info0.16.0
Modernize our package metadata in the following ways: * switch from description-file to long_description with the file attribute, and specify an explicit content type and encoding * replace the home-page parameter with the newer general url one * use the specific license metadata in addition to the corresponding trove classifier for it * make sure wheels when built also incorporate the LICENSE and AUTHORS files so that we're not distributing them without a copy of the license text * indicate support for all recent Python releases in trove classifiers * drop Python 3.4 cruft from the bindep list https://setuptools.readthedocs.io/en/latest/userguide/declarative_config.html Also replace the contributor documentation with a more up to date copy from opendev/bindep, and adjust the copyright assertions in the built Sphinx docs to refer to "OpenDev Contributors" and drop the unnecessary year. Change-Id: I39c5f5afc66edec0cf51709218f143b2a749eddd
-rw-r--r--CONTRIBUTING.rst52
-rw-r--r--bindep.txt2
-rw-r--r--doc/source/conf.py10
-rw-r--r--setup.cfg29
4 files changed, 59 insertions, 34 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index ff4dae7..1e41ce8 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -1,17 +1,47 @@
-If you would like to contribute to the development of OpenStack,
-you must follow the steps in this page:
+Contribution Overview
+=====================
- http://docs.openstack.org/infra/manual/developers.html
+OpenDev's tools are hosted within the OpenDev collaboratory, and
+development for them uses workflows described in the OpenDev
+Infrastructure Manual:
-If you already have a good understanding of how the system works and your
-OpenStack accounts are set up, you can skip to the development workflow section
-of this documentation to learn how changes to OpenStack should be submitted for
-review via the Gerrit tool:
+http://docs.opendev.org/opendev/manual/developers.html
- http://docs.openstack.org/infra/manual/developers.html#development-workflow
+Defect reporting and task tracking takes place here:
-Pull requests submitted through GitHub will be ignored.
+https://storyboard.openstack.org/#!/project/opendev/gear
-Bugs should be filed on StoryBoard, not GitHub:
+Developing gear
+===============
- https://storyboard.openstack.org/#!/project/714
+Either install `bindep` and run ``bindep test`` to check you have the needed
+tools, or review ``bindep.txt`` by hand. If you have the `tox` utility
+installed you can also use it for this purpose, running ``tox -e bindep test``
+to get a list of missing distribution package dependencies in your development
+environment.
+
+Running Tests
+-------------
+
+The testing system is based on a combination of tox and testr. The canonical
+approach to running tests is to simply run the command `tox`. This will
+create virtual environments, populate them with dependencies and run all of
+the tests that OpenStack CI systems run. Behind the scenes, tox is running
+`testr run --parallel`, but is set up such that you can supply any additional
+testr arguments that are needed to tox. For example, you can run:
+`tox -- --analyze-isolation` to cause tox to tell testr to add
+--analyze-isolation to its argument list.
+
+It is also possible to run the tests inside of a virtual environment
+you have created, or it is possible that you have all of the dependencies
+installed locally already. If you'd like to go this route, the requirements
+are listed in requirements.txt and the requirements for testing are in
+test-requirements.txt. Installing them via pip, for instance, is simply::
+
+ pip install -r requirements.txt -r test-requirements.txt
+
+In you go this route, you can interact with the testr command directly.
+Running `testr run` will run the entire test suite. `testr run --parallel`
+will run it in parallel (this is the default incantation tox uses.) More
+information about testr can be found at:
+https://testrepository.readthedocs.io/en/latest/
diff --git a/bindep.txt b/bindep.txt
index ea5092a..e6c6331 100644
--- a/bindep.txt
+++ b/bindep.txt
@@ -8,6 +8,4 @@ python-devel [platform:rpm]
python3-all-dev [platform:ubuntu !platform:ubuntu-precise]
python3-dev [platform:dpkg]
python3-devel [platform:fedora]
-python3.4 [platform:ubuntu-trusty]
python3.5 [platform:ubuntu-xenial]
-python34-devel [platform:centos]
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 9f05b93..bde041d 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -42,7 +42,7 @@ master_doc = 'index'
# General information about the project.
project = 'Gear'
-copyright = '2013, OpenStack Foundation'
+copyright = 'OpenDev Contributors'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
@@ -185,7 +185,7 @@ latex_elements = {
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'Gear.tex', 'Gear Documentation',
- 'OpenStack Foundation', 'manual'),
+ 'OpenDev Contributors', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
@@ -215,9 +215,9 @@ latex_documents = [
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'gear', 'Gear Full Documentation',
- ['OpenStack Foundation'], 1),
+ ['OpenDev Contributors'], 1),
('geard', 'geard', 'async pure python Gearman daemon',
- ['OpenStack Foundation'], 8),
+ ['OpenDev Contributors'], 8),
]
# If true, show URL addresses after external links.
@@ -231,7 +231,7 @@ man_pages = [
# dir menu entry, description, category)
texinfo_documents = [
('index', 'Gear', 'Gear Documentation',
- 'OpenStack Foundation', 'Gear', 'One line description of project.',
+ 'OpenDev Contributors', 'Gear', 'One line description of project.',
'Miscellaneous'),
]
diff --git a/setup.cfg b/setup.cfg
index da65459..c05a2d3 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -1,20 +1,23 @@
[metadata]
name = gear
-author = OpenStack
-author-email = openstack-discuss@lists.openstack.org
+author = OpenDev Contributors
+author-email = service-discuss@lists.opendev.org
summary = Pure Python Async Gear Protocol Library
-description-file =
- README.rst
-home-page = https://opendev.org/opendev/gear
+long_description = file: README.rst
+long_description_content_type = text/x-rst; charset=UTF-8
+url = https://docs.opendev.org/opendev/gear
project_urls =
Bug Tracker = https://storyboard.openstack.org/#!/project/opendev/gear
CI: Zuul = https://zuul.opendev.org/t/opendev/builds?project=opendev/gear
Source Code = https://opendev.org/opendev/gear
Documentation = https://docs.opendev.org/opendev/gear/
+license = Apache License, Version 2.0
+license_files =
+ AUTHORS
+ LICENSE
classifier =
Development Status :: 4 - Beta
Environment :: Console
- Environment :: OpenStack
Intended Audience :: Developers
Intended Audience :: Information Technology
License :: OSI Approved :: Apache Software License
@@ -24,6 +27,10 @@ classifier =
Programming Language :: Python :: 2.7
Programming Language :: Python :: 3
Programming Language :: Python :: 3.5
+ Programming Language :: Python :: 3.6
+ Programming Language :: Python :: 3.7
+ Programming Language :: Python :: 3.8
+ Programming Language :: Python :: 3.9
[files]
packages =
@@ -35,13 +42,3 @@ console_scripts =
[bdist_wheel]
universal = 1
-
-[build_sphinx]
-all_files = 1
-build-dir = doc/build
-source-dir = doc/source
-
-[egg_info]
-tag_build =
-tag_date = 0
-tag_svn_revision = 0