diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..d62034391 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,15 @@ +## Contributing + +We have provided detailed documentation for ways in which you can +contribute to Pulp here: +https://pulpproject.org/dev/ + +This documentation includes: + +* Suggestions of how to contribute +* How we track bugs +* Ways to get in touch with other contributors who can advise you +* A contribution checklist +* A developer guide + +Join us! We look forward to hearing from you. diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst deleted file mode 100644 index 7d770c735..000000000 --- a/CONTRIBUTING.rst +++ /dev/null @@ -1,35 +0,0 @@ -Contributing -============ - -To contribute to the ``pulp_container`` package follow this process: - -1. Clone the GitHub repo -2. Make a change -3. Make sure all tests passed -4. Add a file into ``CHANGES`` folder (Changelog update). -5. Commit changes to own ``pulp_container`` clone -6. Make pull request from github page for your clone against master branch - - -.. _changelog-update: - -Changelog update -**************** - -The ``CHANGES.rst`` file is managed using the `towncrier tool `_ -and all non trivial changes must be accompanied by a news entry. - -To add an entry to the news file, you first need an issue describing the change you want to make. -Once you have an issue, take its number and create a file inside of the ``CHANGES/`` directory -named after that issue number with an extension of ``.feature``, ``.bugfix``, ``.doc``, -``.removal``, or ``.misc``. So if your issue is ``3543`` and it fixes a bug, you would create the -file ``CHANGES/3543.bugfix``. - -PRs can span multiple categories by creating multiple files (for instance, if you added a feature -and deprecated an old feature at the same time, you would create ``CHANGES/NNNN.feature`` and -``CHANGES/NNNN.removal``). Likewise if a PR touches multiple issues/PRs you may create a file for -each of them with the exact same contents and Towncrier will deduplicate them. - -The contents of this file are reStructuredText formatted text that will be used as the content of -the news file entry. You do not need to reference the issue or PR numbers here as towncrier will -automatically add a reference to all of the affected issues when rendering the news file. diff --git a/HISTORY.rst b/HISTORY.rst deleted file mode 100644 index 91ba462eb..000000000 --- a/HISTORY.rst +++ /dev/null @@ -1,35 +0,0 @@ -4.0.0b4 -^^^^^^^ - -- Enable sync from registries that use basic auth or have private repos -- Enable on_demand or streamed sync -- Enable whitelist tags specification when syncing -- Compatibility with pulpcore-plugin-0.1.0rc2 - -`Comprehensive list of changes and bugfixes for beta 4 `_. - -4.0.0b3 -^^^^^^^ - -- Enable sync from gcr and quay registries -- Enable support to handle pagination for tags/list endpoint during sync -- Enable support to manage a docker image that has manifest schema v2s1 -- Enable docker distribution to serve directly latest repository version - -`Comprehensive list of changes and bugfixes for beta 3 `_. - -4.0.0b2 -^^^^^^^ - -- Compatibility with pulpcore-plugin-0.1.0rc1 -- Performance improvements and bug fixes -- Add support for syncing repo with foreign layers -- Change sync pipeline to use Futures to handle nested content -- Make Docker distributions asyncronous -- Add support to create publication directly - -4.0.0b1 -^^^^^^^ - -- Add support for basic sync of a docker repo form a V2Registry -- Add support for docker/podman pull from a docker distbution served by Pulp diff --git a/MANIFEST.in b/MANIFEST.in index ab139d972..0b24949bf 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,6 +1,5 @@ include LICENSE include pulp_container/app/webserver_snippets/* -include requirements.txt include pyproject.toml include CHANGES.md include COMMITMENT @@ -8,4 +7,5 @@ include COPYRIGHT include functest_requirements.txt include test_requirements.txt include unittest_requirements.txt +exclude CONTRIBUTING.md exclude releasing.md diff --git a/pyproject.toml b/pyproject.toml index 6bdd64733..685d2f246 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,6 +5,43 @@ requires = [ ] build-backend = 'setuptools.build_meta' +[project] +name = "pulp-container" +version = "2.23.0.dev" +description = "Container plugin for the Pulp Project" +readme = "README.md" +authors = [ + {name="Pulp Team", email="pulp-list@redhat.com"}, +] +classifiers=[ + "License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)", + "Operating System :: POSIX :: Linux", + "Development Status :: 5 - Production/Stable", + "Framework :: Django", + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.9", +] +requires-python = ">=3.9" +dependencies = [ + "jsonschema>=4.4,<4.24", + "pulpcore>=3.49.0,<3.70", + "pyjwt[crypto]>=2.4,<2.11", +] + +[project.urls] +Homepage = "https://pulpproject.org" +Documentation = "https://pulpproject.org/pulp_container/" +Repository = "https://github.com/pulp/pulp_container" +"Bug Tracker" = "https://github.com/pulp/pulp_container/issues" +Changelog = "https://pulpproject.org/pulp_container/changes/" + +[project.entry-points."pulpcore.plugin"] +pulp_container = "pulp_container:default_app_config" + +[tool.setuptools.packages.find] +where = ["."] + [tool.towncrier] package = "pulp_container" filename = "CHANGES.md" @@ -33,18 +70,13 @@ exclude = ''' [tool.check-manifest] ignore = [ - ".bumpversion.cfg", ".gitleaks.toml", "CHANGES/**", - "CONTRIBUTING.rst", - "HISTORY.rst", "dev_requirements.txt", "doc_requirements.txt", "docs/**", "staging_docs/**", "template_config.yml", - ".travis/**", - ".travis.yml", ".pep8speaks.yml", ".ci/**", ".github/**", @@ -81,4 +113,4 @@ search = "version = \"{current_version}\"" replace = "version = \"{new_version}\"" [[tool.bumpversion.files]] -filename = "./setup.py" \ No newline at end of file +filename = "./setup.py" diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index 4f91fd300..000000000 --- a/requirements.txt +++ /dev/null @@ -1,3 +0,0 @@ -jsonschema>=4.4,<4.24 -pulpcore>=3.49.0,<3.70 -pyjwt[crypto]>=2.4,<2.11 diff --git a/setup.py b/setup.py deleted file mode 100755 index 79fef37da..000000000 --- a/setup.py +++ /dev/null @@ -1,35 +0,0 @@ -#!/usr/bin/env python3 - -from setuptools import find_packages, setup - -with open("requirements.txt") as requirements: - requirements = requirements.readlines() - -with open("README.rst") as f: - long_description = f.read() - -setup( - name="pulp-container", - version="2.23.0.dev", - description="Container plugin for the Pulp Project", - long_description=long_description, - license="GPLv2+", - author="Pulp Team", - author_email="pulp-list@redhat.com", - url="https://pulpproject.org/", - python_requires=">=3.8", - install_requires=requirements, - include_package_data=True, - packages=find_packages(exclude=["tests", "tests.*"]), - classifiers=[ - "License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)", - "Operating System :: POSIX :: Linux", - "Development Status :: 5 - Production/Stable", - "Framework :: Django", - "Programming Language :: Python", - "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.8", - "Programming Language :: Python :: 3.9", - ], - entry_points={"pulpcore.plugin": ["pulp_container = pulp_container:default_app_config"]}, -)