| Name | morgan JSON |
| Version |
0.13.4
JSON |
| download |
| home_page | None |
| Summary | PyPI Mirror for Offline/Restricted Environments |
| upload_time | 2023-09-05 14:53:55 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license |
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License. |
| keywords |
mirror
packages
pypi
pypi-mirror
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Morgan
**PyPI Mirror for Restricted/Offline Environments**
## TOC
<!-- vim-markdown-toc GFM -->
* [Overview](#overview)
* [Features and Concepts](#features-and-concepts)
* [Installation](#installation)
* [Usage](#usage)
* [Sample Configuration File](#sample-configuration-file)
* [How Does Morgan Resolve Dependencies?](#how-does-morgan-resolve-dependencies)
* [Limitations](#limitations)
* [Why Not Use X?](#why-not-use-x)
* [Troubleshooting](#troubleshooting)
* [License](#license)
<!-- vim-markdown-toc -->
## Overview
Morgan is a PyPI mirror for restricted/offline networks/environments, where
access to the Internet is not available. It allows creating small mirrors that
can be used by multiple "client" Python environments (i.e. CPython versions,
operating systems, etc.). The Morgan server is a single-file script that only
uses modules the standard Python library, making it easy to deploy in such
environments.
The basic idea is to run the mirror utility where Internet access is available—which
generates a directory tree ("package index") with all of the required packages,
their dependencies, and the server script—then copy this tree to the restricted
network (going through whatever security policies are in place), run the server
inside the restricted network, and set `pip` in the client environments to use
the mirror instead of pypi.org, which they can't access anyway.
## Features and Concepts
- Runs under **Python 3.7 and up** (both server and mirrorer).
- Package index is a **simple directory tree** that can be easily archived, copied,
rsynced, etc.
- Package index contains a **configuration file** that lists **markers** for
different client **environments** and a list of **package requirement strings** as per [PEP 508](https://peps.python.org/pep-0508/).
- Mirrorer automatically and **recursively mirrors dependencies** of all direct
requirements.
- Only mirrors **optional dependencies** if they were part of the requirement
strings (a.k.a "extras"), or are relevant to the environment markers. This is
true for direct requirements and for dependencies of dependencies.
- For each requirement, downloads the **latest version** that satisfies the
requirement (e.g. "requests>=2.24.0,<2.27.0" will download 2.26.0, whereas
"requests" will download the latest available version).
- Downloads both **source distributions** and **binary distributions**. Only binary
distributions that are relevant to either of the environment markers defined in
the configuration file are downloaded.
- **Server** is a one-file script with **no dependencies** outside the standard library
available in Python 3.7 and above. The script is automatically extracted into
the package index.
- Server implements [PEP 503](https://peps.python.org/pep-0503/) (Simple Repository API),
[PEP 658](https://peps.python.org/pep-0658/) (Serve Distribution Metadata in the Simple Repository API),
and [PEP 691](https://peps.python.org/pep-0691/) (JSON-based Simple API for Python Package Indexes).
## Installation
Morgan is meant to be used as a command line utility (although it can be used
as a library if necessary), therefore it is recommended to install via a utility
such as [pipx](https://github.com/pypa/pipx):
```sh
pipx install morgan
```
You can also install it directly through `pip`:
```sh
python3 -m pip install morgan
```
## Usage
1. Create a directory where the package index will reside.
2. Create a "morgan.ini" file in this directory, with at least one environment
definition and list of requirements (see [Sample Configuration File](#sample-configuration-file) below).
You can use `morgan generate_env >> morgan.ini` to generate a configuration
block for the local interpreter. You can also use `morgan generate_reqs >> morgan.ini`
to generate list of requirements from all packages installed in the current
environment, which is especially useful when using virtual environments.
3. Run the mirrorer from inside the package index via `morgan mirror` (alternatively,
provide the path of the package index via the `--index-path` flag).
4. Copy the package index to the target environment, if necessary.
5. Run the server using `python3 server.py`. Use `--help` for a full list of
flags and options. You can also use `morgan server` instead.
### Sample Configuration File
Environment configuration blocks can be automatically generated via
`morgan generate_env`. I recommend you read the "Environment Markers" section of
[PEP 508](https://peps.python.org/pep-0508/#environment-markers) to see exactly how they are calculated.
```ini
[env.legacy]
python_version = 3.7
python_full_version = 3.7.7
os_name = posix
sys_platform = linux
platform_machine = i686
platform_python_implementation = CPython
platform_system = Linux
implementation_name = cpython
[env.edge]
os_name = posix
sys_platform = linux
platform_machine = x86_64
platform_python_implementation = CPython
platform_system = Linux
python_version = 3.10
python_full_version = 3.10.6
implementation_name = cpython
[requirements]
requests = >=2.24.0
protobuf = ==3.20.1
redis = >4.1.0,<4.2.1
xonsh = [full]~=0.11.0
```
In this example we can see two different client environments: a "legacy" one with
a relatively old installation of CPython 3.7.7 on 32-bit Linux, and an "edge"
environment with a recent installation of CPython 3.10.6 on 64-bit Linux.
All these different markers are needed because they can be used in package
metadata, and Morgan needs them to determine which files and dependencies to
download.
This configuration file sets "requests", "protobuf", "redis" and "xonsh" as the
packages to mirror, with certain version specifications for each. The xonsh
requirements also specifies an extra which results in the downloading of certain
optional dependencies. When the mirrorer is executed on a directory that contains this configuration file, it will find the
latest version that satisfies the specifications of each package, download
relevant files for each of them, and then recursively download _their_
dependencies. It will download source files suitable for any environment, and
binary distributions (wheels) that match the definitions of the "legacy" and
"edge" environments.
Configuration markers for a specific environment can easily be generated by
running the provided `generate_env` command in the target environment.
## How Does Morgan Resolve Dependencies?
Dependency resolution in Python is hard. The standard for specifying dependencies
was only created in 2015 with [PEP 508](https://peps.python.org/pep-0508/). For years (and to this day), many projects
have used setuptools for distribution, which had its own mechanisms for
dependency specifications. Many Python packages define their dependencies in
non-standard files such as Setuptools' requires.txt file, and not in their actual
METADATA files, despite the latter supporting dependency specification. Today,
setuptools has moved to using the newer pyproject.toml format standardized by
[PEP 621](https://peps.python.org/pep-0621/).
Many tools that attempt to extract requirements from package metadata, such as
[pkginfo](https://pythonhosted.org/pkginfo/), do not return dependencies listed outside standard METADATA files.
[pip-tools](https://pip-tools.readthedocs.io/) is the only tool outside of pip
itself that can resolve dependencies from multiple sources, but like pip itself,
it is not meant to be used as a library, and it is also meant to be used on
project development sources, not project distributions.
Morgan, therefore, implements its own dependency resolution (which heavily relies
on the [packaging](https://pypi.org/project/packaging/) library). It utilizes an
incremental strategy for extracting metadata from package distributions (whether
source or binary distributions), parsing any file that may contain necessary
metadata. Currently this includes METADATA, PKG-INFO, requires.txt,
setup_requires.txt and pyproject.toml files. Morgan also takes into account
build dependencies to ensure that packages that are necessary to compile source
distributions are also available in the mirror (so, if a source distribution
requires [hatch](https://hatch.pypa.io/) in order to build, Morgan will ensure hatch is mirrored as
well).
It should be noted that recursively resolving dependencies is difficult, and
requires care in order to prevent circular dependencies. Morgan's current
strategy is very simple and possibly too broad, and although I haven't yet found
any issues, they may happen. Please open a ticket if you encounter any such
issues.
## Limitations
- Morgan currently only targets CPython. Packages/binary files that are specific
to other Python implementations are not mirrored. This may change in the
future.
- Morgan only targets Python 3 packages. Python 2 packages are not mirrored and
there's no currently any plan to support them.
- The only binary distributions supported are wheels. Eggs are not supported and
probably never will be.
- The Morgan server is currently read-only. Packages cannot be published to the
index through it. This may change in the future.
- Morgan does not mirror packages with versions that do not comply with
[PEP 440](https://peps.python.org/pep-0440/#version-scheme).
These are generally older packages that are no longer accepted by PyPI anyway.
This is unlikely to change.
- Morgan does not mirror yanked files (see [PEP 592](https://peps.python.org/pep-0592/)). This is how PyPI supports
removing files without breaking projects that are specifically pinned to
them. This was a conscious decision that will probably not change, but
may be made configurable.
## Why Not Use X?
Morgan was written because of insufficiencies of other mirroring solutions:
- [bandersnatch](https://github.com/pypa/bandersnatch/) is geared more towards mirroring of the entire PyPI repository,
with support for different filters to reduce/limit the size of the mirror.
Unfortunately, it doesn't automatically download dependencies of direct
requirements, making the "package" filter virtually unusable, and the "platform"
filters are not fine-grained enough. It also has many dependencies outside the
standard library.
- [localshop](https://github.com/jazzband/localshop) is a proxy that basically caches PyPI responses to `pip` requests,
so it's not useful for restricted networks. It also has many non-standard-library
dependencies, and can't download binary distributions for multiple environments.
- [devpi](https://www.devpi.net/) also works as a caching proxy, and also attempts to automatically refresh
from PyPI at regular intervals. It also has many non-standard-library
dependencies.
- [pypickup](https://github.com/UB-Quantic/pypickup) was started around the same time as Morgan. It is more fitting for
and offline mirror than the above three but takes a different approach than Morgan. It
doesn't include a server, instead relying on `pip`'s ability to install from
a directory tree, so this tree needs to be accessible to your servers. It also
favors CLI commands over a configuration file (e.g. an `add` command is used to
mirror a dependency). I'm not sure how it resolves dependencies, if at all.
## Troubleshooting
- **pip fails installing a package file that exists.**
If `pip` fails with a message similar to "ERROR: Could not find a version
that satisfies the requirement FastAPI (from versions: 0.88.0)", despite
package files existing with the correct version and platform, it may be
that you're providing `pip` with a non-normalized name. You can either
use the normalized name when installing (lowercase the package name and
replace underscores with dashes, e.g. `pip install fastapi` instead of
`pip install FastAPI`), or start the server with the `--no-metadata` flag,
which will disable serving metadata files and workaround the issue. This seems
to be a non-standard behavior in `pip`, as it is sending the normalized name
to the server, but for some reason expecting to get the non-normalized name
back.
## License
Morgan is distributed under the terms of the [Apache License 2.0](LICENSE).
Raw data
{
"_id": null,
"home_page": null,
"name": "morgan",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "mirror,packages,pypi,pypi-mirror",
"author": null,
"author_email": "Ido Perlmuter <ido@ido50.net>",
"download_url": "https://files.pythonhosted.org/packages/c9/13/598dbe07081fd3d17215af36b7050712955bb8a8f17e76d762a0840520b8/morgan-0.13.4.tar.gz",
"platform": null,
"description": "# Morgan\n\n**PyPI Mirror for Restricted/Offline Environments**\n\n## TOC\n\n<!-- vim-markdown-toc GFM -->\n\n* [Overview](#overview)\n* [Features and Concepts](#features-and-concepts)\n* [Installation](#installation)\n* [Usage](#usage)\n * [Sample Configuration File](#sample-configuration-file)\n* [How Does Morgan Resolve Dependencies?](#how-does-morgan-resolve-dependencies)\n* [Limitations](#limitations)\n* [Why Not Use X?](#why-not-use-x)\n* [Troubleshooting](#troubleshooting)\n* [License](#license)\n\n<!-- vim-markdown-toc -->\n\n## Overview\n\nMorgan is a PyPI mirror for restricted/offline networks/environments, where\naccess to the Internet is not available. It allows creating small mirrors that\ncan be used by multiple \"client\" Python environments (i.e. CPython versions,\noperating systems, etc.). The Morgan server is a single-file script that only\nuses modules the standard Python library, making it easy to deploy in such\nenvironments.\n\nThe basic idea is to run the mirror utility where Internet access is available\u2014which\ngenerates a directory tree (\"package index\") with all of the required packages,\ntheir dependencies, and the server script\u2014then copy this tree to the restricted\nnetwork (going through whatever security policies are in place), run the server\ninside the restricted network, and set `pip` in the client environments to use\nthe mirror instead of pypi.org, which they can't access anyway.\n\n## Features and Concepts\n\n- Runs under **Python 3.7 and up** (both server and mirrorer).\n- Package index is a **simple directory tree** that can be easily archived, copied,\n rsynced, etc.\n- Package index contains a **configuration file** that lists **markers** for\n different client **environments** and a list of **package requirement strings** as per [PEP 508](https://peps.python.org/pep-0508/).\n- Mirrorer automatically and **recursively mirrors dependencies** of all direct\n requirements.\n- Only mirrors **optional dependencies** if they were part of the requirement\n strings (a.k.a \"extras\"), or are relevant to the environment markers. This is\n true for direct requirements and for dependencies of dependencies.\n- For each requirement, downloads the **latest version** that satisfies the\n requirement (e.g. \"requests>=2.24.0,<2.27.0\" will download 2.26.0, whereas\n \"requests\" will download the latest available version).\n- Downloads both **source distributions** and **binary distributions**. Only binary\n distributions that are relevant to either of the environment markers defined in\n the configuration file are downloaded.\n- **Server** is a one-file script with **no dependencies** outside the standard library\n available in Python 3.7 and above. The script is automatically extracted into\n the package index.\n- Server implements [PEP 503](https://peps.python.org/pep-0503/) (Simple Repository API),\n [PEP 658](https://peps.python.org/pep-0658/) (Serve Distribution Metadata in the Simple Repository API),\n and [PEP 691](https://peps.python.org/pep-0691/) (JSON-based Simple API for Python Package Indexes).\n\n## Installation\n\nMorgan is meant to be used as a command line utility (although it can be used\nas a library if necessary), therefore it is recommended to install via a utility\nsuch as [pipx](https://github.com/pypa/pipx):\n\n```sh\npipx install morgan\n```\n\nYou can also install it directly through `pip`:\n\n```sh\npython3 -m pip install morgan\n```\n\n## Usage\n\n1. Create a directory where the package index will reside.\n2. Create a \"morgan.ini\" file in this directory, with at least one environment\n definition and list of requirements (see [Sample Configuration File](#sample-configuration-file) below).\n You can use `morgan generate_env >> morgan.ini` to generate a configuration\n block for the local interpreter. You can also use `morgan generate_reqs >> morgan.ini`\n to generate list of requirements from all packages installed in the current\n environment, which is especially useful when using virtual environments.\n3. Run the mirrorer from inside the package index via `morgan mirror` (alternatively,\n provide the path of the package index via the `--index-path` flag).\n4. Copy the package index to the target environment, if necessary.\n5. Run the server using `python3 server.py`. Use `--help` for a full list of\n flags and options. You can also use `morgan server` instead.\n\n### Sample Configuration File\n\nEnvironment configuration blocks can be automatically generated via\n`morgan generate_env`. I recommend you read the \"Environment Markers\" section of\n[PEP 508](https://peps.python.org/pep-0508/#environment-markers) to see exactly how they are calculated.\n\n```ini\n[env.legacy]\npython_version = 3.7\npython_full_version = 3.7.7\nos_name = posix\nsys_platform = linux\nplatform_machine = i686\nplatform_python_implementation = CPython\nplatform_system = Linux\nimplementation_name = cpython\n\n[env.edge]\nos_name = posix\nsys_platform = linux\nplatform_machine = x86_64\nplatform_python_implementation = CPython\nplatform_system = Linux\npython_version = 3.10\npython_full_version = 3.10.6\nimplementation_name = cpython\n\n[requirements]\nrequests = >=2.24.0\nprotobuf = ==3.20.1\nredis = >4.1.0,<4.2.1\nxonsh = [full]~=0.11.0\n```\n\nIn this example we can see two different client environments: a \"legacy\" one with\na relatively old installation of CPython 3.7.7 on 32-bit Linux, and an \"edge\"\nenvironment with a recent installation of CPython 3.10.6 on 64-bit Linux.\n\nAll these different markers are needed because they can be used in package\nmetadata, and Morgan needs them to determine which files and dependencies to\ndownload.\n\nThis configuration file sets \"requests\", \"protobuf\", \"redis\" and \"xonsh\" as the\npackages to mirror, with certain version specifications for each. The xonsh\nrequirements also specifies an extra which results in the downloading of certain\noptional dependencies. When the mirrorer is executed on a directory that contains this configuration file, it will find the\nlatest version that satisfies the specifications of each package, download\nrelevant files for each of them, and then recursively download _their_\ndependencies. It will download source files suitable for any environment, and\nbinary distributions (wheels) that match the definitions of the \"legacy\" and\n\"edge\" environments.\n\nConfiguration markers for a specific environment can easily be generated by\nrunning the provided `generate_env` command in the target environment.\n\n## How Does Morgan Resolve Dependencies?\n\nDependency resolution in Python is hard. The standard for specifying dependencies\nwas only created in 2015 with [PEP 508](https://peps.python.org/pep-0508/). For years (and to this day), many projects\nhave used setuptools for distribution, which had its own mechanisms for\ndependency specifications. Many Python packages define their dependencies in\nnon-standard files such as Setuptools' requires.txt file, and not in their actual\nMETADATA files, despite the latter supporting dependency specification. Today,\nsetuptools has moved to using the newer pyproject.toml format standardized by\n[PEP 621](https://peps.python.org/pep-0621/).\n\nMany tools that attempt to extract requirements from package metadata, such as\n[pkginfo](https://pythonhosted.org/pkginfo/), do not return dependencies listed outside standard METADATA files.\n[pip-tools](https://pip-tools.readthedocs.io/) is the only tool outside of pip\nitself that can resolve dependencies from multiple sources, but like pip itself,\nit is not meant to be used as a library, and it is also meant to be used on\nproject development sources, not project distributions.\n\nMorgan, therefore, implements its own dependency resolution (which heavily relies\non the [packaging](https://pypi.org/project/packaging/) library). It utilizes an\nincremental strategy for extracting metadata from package distributions (whether\nsource or binary distributions), parsing any file that may contain necessary\nmetadata. Currently this includes METADATA, PKG-INFO, requires.txt,\nsetup_requires.txt and pyproject.toml files. Morgan also takes into account\nbuild dependencies to ensure that packages that are necessary to compile source\ndistributions are also available in the mirror (so, if a source distribution\nrequires [hatch](https://hatch.pypa.io/) in order to build, Morgan will ensure hatch is mirrored as\nwell).\n\nIt should be noted that recursively resolving dependencies is difficult, and\nrequires care in order to prevent circular dependencies. Morgan's current\nstrategy is very simple and possibly too broad, and although I haven't yet found\nany issues, they may happen. Please open a ticket if you encounter any such\nissues.\n\n## Limitations\n\n- Morgan currently only targets CPython. Packages/binary files that are specific\n to other Python implementations are not mirrored. This may change in the\n future.\n\n- Morgan only targets Python 3 packages. Python 2 packages are not mirrored and\n there's no currently any plan to support them.\n\n- The only binary distributions supported are wheels. Eggs are not supported and\n probably never will be.\n\n- The Morgan server is currently read-only. Packages cannot be published to the\n index through it. This may change in the future.\n\n- Morgan does not mirror packages with versions that do not comply with\n [PEP 440](https://peps.python.org/pep-0440/#version-scheme).\n These are generally older packages that are no longer accepted by PyPI anyway.\n This is unlikely to change.\n\n- Morgan does not mirror yanked files (see [PEP 592](https://peps.python.org/pep-0592/)). This is how PyPI supports\n removing files without breaking projects that are specifically pinned to\n them. This was a conscious decision that will probably not change, but\n may be made configurable.\n\n## Why Not Use X?\n\nMorgan was written because of insufficiencies of other mirroring solutions:\n\n- [bandersnatch](https://github.com/pypa/bandersnatch/) is geared more towards mirroring of the entire PyPI repository,\n with support for different filters to reduce/limit the size of the mirror.\n Unfortunately, it doesn't automatically download dependencies of direct\n requirements, making the \"package\" filter virtually unusable, and the \"platform\"\n filters are not fine-grained enough. It also has many dependencies outside the\n standard library.\n- [localshop](https://github.com/jazzband/localshop) is a proxy that basically caches PyPI responses to `pip` requests,\n so it's not useful for restricted networks. It also has many non-standard-library\n dependencies, and can't download binary distributions for multiple environments.\n- [devpi](https://www.devpi.net/) also works as a caching proxy, and also attempts to automatically refresh\n from PyPI at regular intervals. It also has many non-standard-library\n dependencies.\n- [pypickup](https://github.com/UB-Quantic/pypickup) was started around the same time as Morgan. It is more fitting for\n and offline mirror than the above three but takes a different approach than Morgan. It\n doesn't include a server, instead relying on `pip`'s ability to install from\n a directory tree, so this tree needs to be accessible to your servers. It also\n favors CLI commands over a configuration file (e.g. an `add` command is used to\n mirror a dependency). I'm not sure how it resolves dependencies, if at all.\n\n## Troubleshooting\n\n- **pip fails installing a package file that exists.**\n\n If `pip` fails with a message similar to \"ERROR: Could not find a version\n that satisfies the requirement FastAPI (from versions: 0.88.0)\", despite\n package files existing with the correct version and platform, it may be\n that you're providing `pip` with a non-normalized name. You can either\n use the normalized name when installing (lowercase the package name and\n replace underscores with dashes, e.g. `pip install fastapi` instead of\n `pip install FastAPI`), or start the server with the `--no-metadata` flag,\n which will disable serving metadata files and workaround the issue. This seems\n to be a non-standard behavior in `pip`, as it is sending the normalized name\n to the server, but for some reason expecting to get the non-normalized name\n back.\n\n## License\n\nMorgan is distributed under the terms of the [Apache License 2.0](LICENSE).\n",
"bugtrack_url": null,
"license": "\n Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n \n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n \n 1. Definitions.\n \n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n \n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n \n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n \n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n \n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n \n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n \n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n \n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n \n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n \n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n \n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n \n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n \n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n \n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n \n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n \n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n \n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n \n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n \n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n \n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n \n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n \n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n \n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n \n END OF TERMS AND CONDITIONS\n \n APPENDIX: How to apply the Apache License to your work.\n \n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n \n Copyright [yyyy] [name of copyright owner]\n \n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n \n http://www.apache.org/licenses/LICENSE-2.0\n \n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.",
"summary": "PyPI Mirror for Offline/Restricted Environments",
"version": "0.13.4",
"project_urls": {
"Bug Tracker": "https://github.com/ido50/morgan/issues",
"Changelog": "https://github.com/ido50/morgan/releases",
"Homepage": "https://github.com/ido50/morgan",
"Repository": "https://github.com/ido50/morgan"
},
"split_keywords": [
"mirror",
"packages",
"pypi",
"pypi-mirror"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "330614133aa005f17615fcf9b82d1dcc9d7fde3504da4627ac75c30d942e5863",
"md5": "c5ee4fdae2ebf7f03e24cde409ce3dbf",
"sha256": "23e4008a5d169c25db786d8d2974ae38434a7eec1230670538fda426d7758ae0"
},
"downloads": -1,
"filename": "morgan-0.13.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c5ee4fdae2ebf7f03e24cde409ce3dbf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 27145,
"upload_time": "2023-09-05T14:53:57",
"upload_time_iso_8601": "2023-09-05T14:53:57.833140Z",
"url": "https://files.pythonhosted.org/packages/33/06/14133aa005f17615fcf9b82d1dcc9d7fde3504da4627ac75c30d942e5863/morgan-0.13.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "c913598dbe07081fd3d17215af36b7050712955bb8a8f17e76d762a0840520b8",
"md5": "d5d026276da6fabde89fef6c41550374",
"sha256": "6b8399e244c301369e776ea59615ddf03f6416e0d82f77eeb02aed97323724b8"
},
"downloads": -1,
"filename": "morgan-0.13.4.tar.gz",
"has_sig": false,
"md5_digest": "d5d026276da6fabde89fef6c41550374",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 21882,
"upload_time": "2023-09-05T14:53:55",
"upload_time_iso_8601": "2023-09-05T14:53:55.557467Z",
"url": "https://files.pythonhosted.org/packages/c9/13/598dbe07081fd3d17215af36b7050712955bb8a8f17e76d762a0840520b8/morgan-0.13.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-05 14:53:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ido50",
"github_project": "morgan",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "morgan"
}
