Commit Graph

45 Commits

Author SHA1 Message Date
Zuul f55524c08e Merge "Use summary for the package summary" 2024-01-30 12:50:25 +00:00
Tim Burke f42ef66d1b Use summary for the package summary
Otherwise, the long_description file isn't used.

Change-Id: Ib494a0bac947cc6b5fb8d3d4315a3d386cbffdc2
2024-01-18 14:53:58 -08:00
Tim Burke 049282adbb Test on py310 and py311
Note that there are already many openstack projects using pbr on these
platforms, seemingly successfully.

Change-Id: If49434ff0b60b5382f374635ccaf2ac2e6489db9
2024-01-18 14:19:42 -08:00
Hervé Beraud 5ded0ee1ff Adding python classifiers py38 & py39
Change-Id: Ib8e251ae9dd93a5eb356478d633f1fef271911d9
2022-05-05 12:06:18 +02:00
yangyawei 09417bf0a3 setup.cfg: Replace dashes with underscores
Setuptools v54.1.0 introduces a warning that the use of
dash-separated options in 'setup.cfg' will not be supported in a
future version [1]. Get ahead of the issue by updating to canonical
configuration[2]. Without this, we see 'UserWarning' messages like
the following on new enough versions of setuptools:

  UserWarning: Usage of dash-separated 'description-file' will not
  be supported in future versions. Please use the underscore name
  'description_file' instead

[1] https://github.com/pypa/setuptools/commit/a2e9ae4cb
[2] https://setuptools.pypa.io/en/stable/userguide/declarative_config.html

Change-Id: I9c51ffdeb548833f2cc303d2e53ba169756690d3
2022-01-21 10:54:56 +01:00
Antoine Musso 07b6ac85e6 Update some url to use opendev.org
The git web URL is now: https://opendev.org/openstack/pbr

Also stop linking README.rst to no more existing history/changelog
documentation page (removed by 96b84a9014).

Change-Id: I56b0e2b86a7fc66c5ae25e06175033a885f500f6
2020-08-06 15:09:50 +02:00
Matthew Treinish 39fe3495d2 Update python requires packaging metadata for package
The metadata field, 'python-requires' was introduced in PEP440 and
appears to have superseded 'requires-python'. [1] The metadata that pbr
uses for itself and it's test package was using the old incorrect field,
this commit updates it to be the proper metadata to show a working
example. To a certain extent it probably doesn't matter because it's very
unlikely someone will try to install pbr with python 2.5, but it's more
about making sure that pbr itself is leading by example and that it's own
config actually works.

[1] https://github.com/mtreinish/stestr/issues/292

Change-Id: I5eb14d490a3731b6b95d7a1137c33ec2d73f193f
2020-08-06 08:28:11 +00:00
Stephen Finucane 79ef8d989a Resolve some issue with tox.ini, setup.cfg
- Use constraints for documentation targets
- Indicate support for Python 3.6, 3.7
- Fix indentation

Change-Id: I486b6f645fa71f0fa519464465bf26411ca4faf4
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-06-13 15:46:30 +01:00
Ben Nemec 96b84a9014 Stop using pbr sphinx integration
Switch to sphinx-build directly and add sphinxcontrib-apidoc for
generated api docs.

Change-Id: I089a7695986892dcb47c5b5e79a6a227891a2347
2019-06-07 18:37:58 +01:00
qingszhao 11cf070f94 Change openstack-dev to openstack-discuss
Mailinglists have been updated. Openstack-discuss replaces openstack-dev.

Change-Id: I18a5f9696659bce3c03018b636968d5c3c96dc73
2018-12-04 13:18:43 +00:00
Stephen Finucane f14a3b2b73 Support wheel 0.32.0+
Wheel 0.32.0 removed the 'wheel install' command [1] and, subsequently,
the 'wheel.install' module [2]. It also made 'WheelFile' a subclass of
'zipfile.ZipFile' rather than a wrapper [2] and deprecated the '[wheel]'
section of 'setup.cfg' in favour of '[bdist_wheel]'. Handle these
changes.

[1] https://github.com/pypa/wheel/commit/353217fb4
[2] https://github.com/pypa/wheel/commit/89492505b

Change-Id: I2903089a07bdd2dc96437b9f65f2d2bba2741707
2018-10-04 10:52:05 +01:00
Stephen Finucane 2222dbb47e Switch to stestr
According to Openstack summit session [1], stestr is maintained project
to which all Openstack projects should migrate. Let's switch to stestr
as other projects have already moved to it.

While we're at it, we also fix the docs requirements and removed the
unused 'pypy' and 'cover' tox targets.

[1] https://etherpad.openstack.org/p/YVR-python-pti

Change-Id: I424068adc9092be2cf40d117c9dc4e92bb51e804
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2018-07-18 10:12:17 +01:00
Zuul 8a9a6d80bf Merge "Support PEP 345 Project-URL metadata" 2018-01-08 13:54:33 +00:00
Jeremy Stanley 538d2c21a1 Support Description-Content-Type metadata
As of setuptools 36.4.0, support for Description-Content-Type
metadata was added via the long_description_content_type variable.
Add a metadata.description-content-type option for setup.cfg so it
can be provided through PBR. This makes it possible to instruct PyPI
and potentially other frontends to know an explicit RFC 1341 content
type, along with character set and variant, for the accompanying
long description.

Change-Id: I852f603d9ca4e4cd469eab4cae9933ef2581e3af
2017-12-04 19:46:41 +00:00
Jeremy Stanley 839ef3428d Support PEP 345 Project-URL metadata
By including one or more Project-URL entries in PKG-INFO metadata,
PyPI can display helpful hyperlinks in a generic manner. Add support
here to be able to pass it through setup.cfg with a project_urls
dict. See the corresponding section of the Core Metadata
Specifications from the Python Packaging User Guide for details:

https://packaging.python.org/specifications/core-metadata/#project-url-multiple-use

Setuptools implementation is underway here:

    https://github.com/pypa/setuptools/pull/1210

Change-Id: I14e580c654b619cab7eb24e31f736056d6cf9bd4
2017-11-22 23:55:17 +00:00
zhangyangyang 558980151a Remove py26 support
as of mitaka, the infra team won't have the resources available to
reasonably test py26, also the oslo team is dropping py26 support
from their libraries. sine we rely on oslo for a lot of our work,
and depend on infra for our CI, we should drop py26 support too.

Change-Id: I628f5a1463a893bfc16f795ef7144cd2376130de
Closes-Bug: #1519510
2017-09-20 09:57:15 +08:00
ChangBo Guo(gcb) 4fc2518539 Update URLs in documents according to document migration
Change-Id: I8018f0cc0b0f7642d9e0e65f14c9c8a8315b55b9
2017-07-13 12:16:24 +08:00
Doug Hellmann f323413992 turn on warning-as-error flag for doc build
Change-Id: I5566cfa09dac8dec7a1bc32d95b42d5b136d726f
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-22 16:08:39 -04:00
Doug Hellmann 2fa5003a05 rearrange existing documentation using the new standard layout
Change-Id: I885f1adf4fbfc1137c6c48039096bd7bdf89cbd3
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-22 16:08:39 -04:00
Jenkins f377238903 Merge "Remove testr entry point" 2017-03-27 23:12:29 +00:00
Stephen Finucane 72e8e42a34 Stop using 'warnerrors'
This legacy option provided the ability to fail on doc warnings.
However, this functionality is broken in recent releases and now exists
in Sphinx itself (since 1.5.0). Rather that fixing it and causing a
whole load of doc build errors introduced in the time since this option
was broken, remove it, preferring the new Sphinx option instead.

This allows us to remove a lot of test code which is essentially testing
Sphinx functionality only now, based on the assumption that Sphinx do
adequate testing themselves.

Change-Id: Ia4b6adefcd437cb1ceb4558b004c17359df2486d
2017-02-27 14:20:57 +00:00
Ian Wienand e3ad98ca19 Remove testr entry point
A "testr" entry-point was added to PBR in
I2227adf3643ffe6bcece0c7d2127d23e20d52f7a in Jun 2013.  However,
testrepository had already started providing this same
disutils.commands entry-point in Jan 2013 [1].

I am not sure if it is deterministic who wins when two packages
declare the same entry-point, but at least for me, running "python
setup.py testr ..." was not calling into any of the pbr hooks.  I
discovered this because I wanted to use the --coverage-package-name
argument provided by the pbr testr wrapper because to s/-/_ in dib.

The original change (I8e4bc9bb78be37b4d13f8d6c2edfe2d67554ad78)
overrides the setuptools provided "test" [2] to call testrepository
when it sees a .testr.conf file (falling back to nose for
compatability).  So it seems the intention was not to add a "testr"
command, but that "test" is overridden to run testr automatically when
available.

Therefore I think that testrepository owns the distutils.command
entry-point for "testr".  To avoid confusion we should remove the
duplicate entry-point here and just leave the "test" command
overrides.

I've added documentation on the test command.  The testr/test split is
quite confusing, being only one letter different, so that is called
out explicitly.  Comments in testr_command are updated to reflect
what's happening better.  This also converts the calls in tox.ini to
use the PBR wrapper "test".

[1] 2a36806c69 (diff-2eeaed663bd0d25b7e608891384b7298R96)
[2] https://github.com/pypa/setuptools/blob/master/setuptools/command/test.py

Change-Id: I5b68f03e782fef5c45424c04cc851be5988f9019
2017-02-24 11:30:09 +11:00
nizam 781d13e83a Changed the home-page link
Set the correct link for home-page.

Change-Id: I1ab60f97a5078da98fded6339e1e18f91750c4b9
2016-10-19 16:13:14 +05:30
Jenkins 40c0d5e501 Merge "Move to oslosphinx" 2016-07-20 05:15:29 +00:00
ChangBo Guo(gcb) 4480b9e099 Add Python 3.5 classifier and venv
Now that there is a passing gate job, we can claim support for
Python 3.5 in the classifier. This patch also adds the convenience
py35 venv.

Change-Id: I38213e5ade2e9b1329262c9b28b87ce1cabc279a
2016-07-12 17:28:54 +08:00
Ian Wienand 87288ccfd8 Move to oslosphinx
I noticed the current API documentation is unreadable [1].  Remove the
inbuilt theme and move to oslosphinx for module/api documentation.

[1] http://docs.openstack.org/developer/pbr/api/pbr.version.html

Change-Id: I8d92d849b8a2ab4baca960ae8c271214d3c2b8f4
2016-06-22 13:18:59 +10:00
Davanum Srinivas d28f40db39 Advertise support for Python3.4
Change-Id: I648f865550069209ffbf63dc05bcba3234b026c0
2015-05-08 16:06:45 -04:00
Clark Boylan 3ec9f0e809 Move write_pbr_json to avoid issues with nose
Put write_pbr_json in pbr.pbr_json so that you do not need to import
pbr.packaging to use it. This avoids python3 errors with nose where nose
is imported by pbr before it is converted to python3 by 2to3 under
python3.

Change-Id: I1c420fed609bc60bbfdf78eb219e067ccab1a61e
2014-12-21 22:21:48 +00:00
Monty Taylor c01b8dae1e Port in git sha changes from 0.10 line
Stop including git sha in version strings

We include it in pbr.json now. Including it is contentious in the world
of python, and it's up for debate as to whether or not it provides value.

Write and read more complex git sha info

Instead of encoding the git sha into the version string, add it to
a metadata file. This will allow us to get out of the business of
arguing with pip and setuptools about version info. In order to make
this really nice, provide a command line utility called "pbr" that has
subcommands to print out the metadata that we're now including in the
egg-info dir.

Only import sphinx during hook processing

When pbr is imported to handle writing the egg_info file because of
the entry point, it's causing sphinx to get imported. This has a
cascading effect once docutils is trying to be installed on a system
with pbr installed. If some of the imports fail along the way, allow
pbr to continue usefully but without the Sphinx extensions
available. Eventually, when everything is installed, those
extensions will work again when the commands for build_sphinx, etc.
are run separately.

Also slip in a change to reorder the default list of environments
run by tox so the testr database is created using a dbm format
available to all python versions.

Integration test PBR commits

Make sure that if a PBR commit is being tested then we install and
use that source rather than the latest PBR release.

Change-Id: Ie121e795be2eef30822daaa5fe8ab1c2315577ae
(cherry picked from commit 65f4fafd90)
(cherry picked from commit cd7da23937)
Closes-Bug: #1403510
Co-Authored-By: Clark Boylan <clark.boylan@gmail.com>
Co-Authored-By: Doug Hellmann <doug@doughellmann.com>
Co-Authored-By: Jeremy Stanley <fungi@yuggoth.org>
2014-12-21 22:20:49 +00:00
Doug Hellmann 19848e6cf1 Clean up links and docs
Move some developer information for running tests out of the README to
the documentation.

Change the home page link to point to the launchpad page.

Add a link to the bug tracker to the README.

Change-Id: I29bdb071eb64bccc561844c130a256b8f998da5f
Closes-Bug: #1318548
2014-10-08 16:49:59 -04:00
Steve Kowalik 715c59738e Register testr as a distutil entry point
pbr contains a testr distutil command, but since it isn't registered
as an entry-point, it won't get used. Also drive-by a fix to
coverage, where we go to the trouble of setting a variable, and then
not using it.

Change-Id: I2227adf3643ffe6bcece0c7d2127d23e20d52f7a
2014-06-11 16:31:15 +10:00
Alex Gaynor fa26159595 Declare support for Python versions in setup.cfg
Change-Id: Iffdcf7a6eab6990f9b32669070b8a4173e834613
2014-03-01 09:18:35 -08:00
Jenkins 2c083424c9 Merge "Support building wheels (PEP-427)" 2013-11-23 07:57:06 +00:00
Alex Gaynor c4ebf4318c Bump the development status classifier.
Change-Id: Ib64c45080ad256fd0019072deef19fb76516486c
2013-11-19 08:06:29 -08:00
Sascha Peilicke e13b3a578d Support building wheels (PEP-427)
With that, building and uploading wheels to PyPI is only one "python
setup.py bdist_wheel" away.

Change-Id: Idfc291f496a81498df6408f189854f49eca496d3
2013-11-19 09:52:31 +01:00
Monty Taylor 904f79c867 Add more documentation
Moved a good portion of README into the sphinx docs. Also started
fleshing out descriptions of how to use things. Also, fix the sphinx
config.

Change-Id: If53dcdaea0a48ef613e3097ab55d34f056160188
2013-07-21 19:54:39 -07:00
Monty Taylor 746b78d637 Clean up hacking and path issues with d2to1
We imported in another code base. It takes a little bit of path
adjusting to get things right.

Change-Id: Ifb96652c822d5d243a6bedb77bc34e919be2d3a8
2013-07-11 15:02:12 -04:00
Monty Taylor 5b8b7f1d83 Align Sphinx autodoc options with oslo.
The Sphinx autodoc changes also went into olso a little differently.

Change-Id: If1f337db693053f2627c0c426a51bc13128033a7
Reviewed-on: https://review.openstack.org/25676
Reviewed-by: James E. Blair <corvus@inaugust.com>
Reviewed-by: Clark Boylan <clark.boylan@gmail.com>
Approved: Monty Taylor <mordred@inaugust.com>
Tested-by: Jenkins
2013-04-06 01:23:32 +00:00
Monty Taylor d0b083d28f Add support for configuring pbr sphinx options.
Change-Id: Idfdd1c8850433bf3ea2439f939756f5c60bb88a1
2013-03-27 16:45:30 +01:00
Monty Taylor 1d3422fefd Update documentation for release.
Change-Id: I215bfa00a836c7fafb535b78e6fef89c81e28817
2013-03-17 23:51:59 -07:00
Monty Taylor e8af43a318 Rename back to PBR.
Change-Id: I13ee7fab7858231b0fa17f9116176a09184e8b0e
2013-03-17 23:27:50 -07:00
Monty Taylor caf4be4778 Just use d2to1 via hooks mechanism.
It turns out we can just have only our code and use d2to1 directly.

Change-Id: I4700ad51bf4377797ede55d3cf5ec09f424874ed
2013-03-11 18:13:45 -04:00
Monty Taylor f618f7c117 Remove version that had been used for testing.
Change-Id: I1ff919b9629c08893ca3df3c38a5afaf21155657
2013-03-10 21:25:54 -04:00
Monty Taylor 8a4789883a Fix things up to work with nova.
Add extern/six back - turns out setup_requires isn't transitive.
Make sure .gitignore is right.
2013-03-10 21:14:15 -04:00
Monty Taylor aa4641f0e6 Split out oslo.packaging.
Include logic taken from d2to1 to allow us to inject into setup.py. Combined
with ols openstack/common/setup.py code.

Change-Id: I27b341403bb8245e38f8e3c386f1a835b90b1843
2013-03-10 18:02:43 -04:00