Skip to content

Commit 9e765ec

Browse files
authored
Merge pull request #121 from nexB/update_readme
Update readme with test instructions
2 parents f2b19f9 + dc0032a commit 9e765ec

14 files changed

+307
-288
lines changed

README.rst

+11
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,17 @@ The goal of python-inspector is to be a comprehensive library
2424
that can handle every style of Python package layouts, manifests and lockfiles.
2525

2626

27+
Testing
28+
--------
29+
30+
- Run the tests with::
31+
32+
pytest -vvs
33+
34+
- These are live tests to regenrate the tests with updated data run::
35+
36+
PYINSP_REGEN_TEST_FIXTURES=yes pytest -vvs
37+
2738
Usage
2839
--------
2940

setup.cfg

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ zip_safe = false
5151

5252
setup_requires = setuptools_scm[toml] >= 4
5353

54-
python_requires = >=3.6.*
54+
python_requires = >=3.7
5555

5656
install_requires =
5757
attrs >= 18.1, !=20.1.0

tests/data/azure-devops.req-310-expected.json

+20-20
Large diffs are not rendered by default.

tests/data/azure-devops.req-38-expected.json

+20-20
Large diffs are not rendered by default.

tests/data/frozen-requirements.txt-expected.json

+17-17
Original file line numberDiff line numberDiff line change
@@ -6013,12 +6013,12 @@
60136013
"type": "pypi",
60146014
"namespace": null,
60156015
"name": "pip",
6016-
"version": "22.3.1",
6016+
"version": "23.0",
60176017
"qualifiers": {},
60186018
"subpath": null,
60196019
"primary_language": "Python",
60206020
"description": "The PyPA recommended tool for installing Python packages.\npip - The Python Package Installer\n==================================\n\n.. image:: https://img.shields.io/pypi/v/pip.svg\n :target: https://pypi.org/project/pip/\n\n.. image:: https://readthedocs.org/projects/pip/badge/?version=latest\n :target: https://pip.pypa.io/en/latest\n\npip is the `package installer`_ for Python. You can use pip to install packages from the `Python Package Index`_ and other indexes.\n\nPlease take a look at our documentation for how to install and use pip:\n\n* `Installation`_\n* `Usage`_\n\nWe release updates regularly, with a new version every 3 months. Find more details in our documentation:\n\n* `Release notes`_\n* `Release process`_\n\nIn pip 20.3, we've `made a big improvement to the heart of pip`_; `learn more`_. We want your input, so `sign up for our user experience research studies`_ to help us do it right.\n\n**Note**: pip 21.0, in January 2021, removed Python 2 support, per pip's `Python 2 support policy`_. Please migrate to Python 3.\n\nIf you find bugs, need help, or want to talk to the developers, please use our mailing lists or chat rooms:\n\n* `Issue tracking`_\n* `Discourse channel`_\n* `User IRC`_\n\nIf you want to get involved head over to GitHub to get the source code, look at our development documentation and feel free to jump on the developer mailing lists and chat rooms:\n\n* `GitHub page`_\n* `Development documentation`_\n* `Development IRC`_\n\nCode of Conduct\n---------------\n\nEveryone interacting in the pip project's codebases, issue trackers, chat\nrooms, and mailing lists is expected to follow the `PSF Code of Conduct`_.\n\n.. _package installer: https://packaging.python.org/guides/tool-recommendations/\n.. _Python Package Index: https://pypi.org\n.. _Installation: https://pip.pypa.io/en/stable/installation/\n.. _Usage: https://pip.pypa.io/en/stable/\n.. _Release notes: https://pip.pypa.io/en/stable/news.html\n.. _Release process: https://pip.pypa.io/en/latest/development/release-process/\n.. _GitHub page: https://github.com/pypa/pip\n.. _Development documentation: https://pip.pypa.io/en/latest/development\n.. _made a big improvement to the heart of pip: https://pyfound.blogspot.com/2020/11/pip-20-3-new-resolver.html\n.. _learn more: https://pip.pypa.io/en/latest/user_guide/#changes-to-the-pip-dependency-resolver-in-20-3-2020\n.. _sign up for our user experience research studies: https://pyfound.blogspot.com/2020/03/new-pip-resolver-to-roll-out-this-year.html\n.. _Python 2 support policy: https://pip.pypa.io/en/latest/development/release-process/#python-2-support\n.. _Issue tracking: https://github.com/pypa/pip/issues\n.. _Discourse channel: https://discuss.python.org/c/packaging\n.. _User IRC: https://kiwiirc.com/nextclient/#ircs://irc.libera.chat:+6697/pypa\n.. _Development IRC: https://kiwiirc.com/nextclient/#ircs://irc.libera.chat:+6697/pypa-dev\n.. _PSF Code of Conduct: https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md",
6021-
"release_date": "2022-11-05T15:56:17",
6021+
"release_date": "2023-01-30T23:10:52",
60226022
"parties": [
60236023
{
60246024
"type": "person",
@@ -6044,11 +6044,11 @@
60446044
"Topic :: Software Development :: Build Tools"
60456045
],
60466046
"homepage_url": "https://pip.pypa.io/",
6047-
"download_url": "https://files.pythonhosted.org/packages/09/bd/2410905c76ee14c62baf69e3f4aa780226c1bbfc9485731ad018e35b0cb5/pip-22.3.1-py3-none-any.whl",
6048-
"size": 2051534,
6047+
"download_url": "https://files.pythonhosted.org/packages/ab/43/508c403c38eeaa5fc86516eb13bb470ce77601b6d2bbcdb16e26328d0a15/pip-23.0-py3-none-any.whl",
6048+
"size": 2056044,
60496049
"sha1": null,
6050-
"md5": "74d0d338e0af6ca545d6ce7ef9734d75",
6051-
"sha256": "908c78e6bc29b676ede1c4d57981d490cb892eb45cd8c214ab6298125119e077",
6050+
"md5": "911a8561240e5b46c50b7e16834d42dd",
6051+
"sha256": "b5f88adff801f5ef052bcdef3daa31b55eb67b0fccd6d0106c206fa248e0463c",
60526052
"sha512": null,
60536053
"bug_tracking_url": null,
60546054
"code_view_url": "https://github.com/pypa/pip",
@@ -6068,20 +6068,20 @@
60686068
"dependencies": [],
60696069
"repository_homepage_url": null,
60706070
"repository_download_url": null,
6071-
"api_data_url": "https://pypi.org/pypi/pip/22.3.1/json",
6071+
"api_data_url": "https://pypi.org/pypi/pip/23.0/json",
60726072
"datasource_id": null,
6073-
"purl": "pkg:pypi/pip@22.3.1"
6073+
"purl": "pkg:pypi/pip@23.0"
60746074
},
60756075
{
60766076
"type": "pypi",
60776077
"namespace": null,
60786078
"name": "pip",
6079-
"version": "22.3.1",
6079+
"version": "23.0",
60806080
"qualifiers": {},
60816081
"subpath": null,
60826082
"primary_language": "Python",
60836083
"description": "The PyPA recommended tool for installing Python packages.\npip - The Python Package Installer\n==================================\n\n.. image:: https://img.shields.io/pypi/v/pip.svg\n :target: https://pypi.org/project/pip/\n\n.. image:: https://readthedocs.org/projects/pip/badge/?version=latest\n :target: https://pip.pypa.io/en/latest\n\npip is the `package installer`_ for Python. You can use pip to install packages from the `Python Package Index`_ and other indexes.\n\nPlease take a look at our documentation for how to install and use pip:\n\n* `Installation`_\n* `Usage`_\n\nWe release updates regularly, with a new version every 3 months. Find more details in our documentation:\n\n* `Release notes`_\n* `Release process`_\n\nIn pip 20.3, we've `made a big improvement to the heart of pip`_; `learn more`_. We want your input, so `sign up for our user experience research studies`_ to help us do it right.\n\n**Note**: pip 21.0, in January 2021, removed Python 2 support, per pip's `Python 2 support policy`_. Please migrate to Python 3.\n\nIf you find bugs, need help, or want to talk to the developers, please use our mailing lists or chat rooms:\n\n* `Issue tracking`_\n* `Discourse channel`_\n* `User IRC`_\n\nIf you want to get involved head over to GitHub to get the source code, look at our development documentation and feel free to jump on the developer mailing lists and chat rooms:\n\n* `GitHub page`_\n* `Development documentation`_\n* `Development IRC`_\n\nCode of Conduct\n---------------\n\nEveryone interacting in the pip project's codebases, issue trackers, chat\nrooms, and mailing lists is expected to follow the `PSF Code of Conduct`_.\n\n.. _package installer: https://packaging.python.org/guides/tool-recommendations/\n.. _Python Package Index: https://pypi.org\n.. _Installation: https://pip.pypa.io/en/stable/installation/\n.. _Usage: https://pip.pypa.io/en/stable/\n.. _Release notes: https://pip.pypa.io/en/stable/news.html\n.. _Release process: https://pip.pypa.io/en/latest/development/release-process/\n.. _GitHub page: https://github.com/pypa/pip\n.. _Development documentation: https://pip.pypa.io/en/latest/development\n.. _made a big improvement to the heart of pip: https://pyfound.blogspot.com/2020/11/pip-20-3-new-resolver.html\n.. _learn more: https://pip.pypa.io/en/latest/user_guide/#changes-to-the-pip-dependency-resolver-in-20-3-2020\n.. _sign up for our user experience research studies: https://pyfound.blogspot.com/2020/03/new-pip-resolver-to-roll-out-this-year.html\n.. _Python 2 support policy: https://pip.pypa.io/en/latest/development/release-process/#python-2-support\n.. _Issue tracking: https://github.com/pypa/pip/issues\n.. _Discourse channel: https://discuss.python.org/c/packaging\n.. _User IRC: https://kiwiirc.com/nextclient/#ircs://irc.libera.chat:+6697/pypa\n.. _Development IRC: https://kiwiirc.com/nextclient/#ircs://irc.libera.chat:+6697/pypa-dev\n.. _PSF Code of Conduct: https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md",
6084-
"release_date": "2022-11-05T15:56:20",
6084+
"release_date": "2023-01-30T23:10:56",
60856085
"parties": [
60866086
{
60876087
"type": "person",
@@ -6107,11 +6107,11 @@
61076107
"Topic :: Software Development :: Build Tools"
61086108
],
61096109
"homepage_url": "https://pip.pypa.io/",
6110-
"download_url": "https://files.pythonhosted.org/packages/a3/50/c4d2727b99052780aad92c7297465af5fe6eec2dbae490aa9763273ffdc1/pip-22.3.1.tar.gz",
6111-
"size": 2078129,
6110+
"download_url": "https://files.pythonhosted.org/packages/b5/16/5e24bf63cff51dcc169f43bd43b86b005c49941e09cc3482a5b370db239e/pip-23.0.tar.gz",
6111+
"size": 2082372,
61126112
"sha1": null,
6113-
"md5": "996f58a94fe0b8b82b6795c42bd171ba",
6114-
"sha256": "65fd48317359f3af8e593943e6ae1506b66325085ea64b706a998c6e83eeaf38",
6113+
"md5": "5d41b9679adae9362026b1753b543cb2",
6114+
"sha256": "aee438284e82c8def684b0bcc50b1f6ed5e941af97fa940e83e2e8ef1a59da9b",
61156115
"sha512": null,
61166116
"bug_tracking_url": null,
61176117
"code_view_url": "https://github.com/pypa/pip",
@@ -6131,9 +6131,9 @@
61316131
"dependencies": [],
61326132
"repository_homepage_url": null,
61336133
"repository_download_url": null,
6134-
"api_data_url": "https://pypi.org/pypi/pip/22.3.1/json",
6134+
"api_data_url": "https://pypi.org/pypi/pip/23.0/json",
61356135
"datasource_id": null,
6136-
"purl": "pkg:pypi/pip@22.3.1"
6136+
"purl": "pkg:pypi/pip@23.0"
61376137
},
61386138
{
61396139
"type": "pypi",
@@ -10940,7 +10940,7 @@
1094010940
{
1094110941
"key": "pip",
1094210942
"package_name": "pip",
10943-
"installed_version": "22.3.1",
10943+
"installed_version": "23.0",
1094410944
"dependencies": []
1094510945
}
1094610946
]

0 commit comments

Comments
 (0)