Rename the project from peo to boltage
The name peo cannot be registered on PyPI. Rename the package, the command, the PEO_* environment variables (now BOLTAGE_*), the container paths and scripts, and the source URLs. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
Bart BroereandClaude Opus 5.5 committed
1 parent
5418473158
commit
5784de249d
20 files changed
+180
-180
No files matched your search
+12
-12
@@ -1,18 +1,18 @@
|
||||
# Third-party notices
|
||||
|
||||
peo's own code (the `peo/`, `container/` and `tests/` directories, the
|
||||
boltage's own code (the `boltage/`, `container/` and `tests/` directories, the
|
||||
`Containerfile`, `compose.yaml` and `pyproject.toml`) is licensed under the GNU General Public
|
||||
License v3.0 or later; see [LICENSE](LICENSE).
|
||||
|
||||
The container images built from this repository also contain the third-party
|
||||
software below. None of it is stored in this repository: it is downloaded when
|
||||
an image is built. Inside the images, license texts are collected under
|
||||
`/usr/share/doc/peo/`.
|
||||
`/usr/share/doc/boltage/`.
|
||||
|
||||
The full image (the default build target) contains everything in the table. The
|
||||
slim image (`--target slim`) contains only neo4j-browser and the JavaScript
|
||||
libraries bundled into it, the Debian base system with Python 3 and
|
||||
`python3-psycopg`, and the Python packages peo depends on.
|
||||
`python3-psycopg`, and the Python packages boltage depends on.
|
||||
|
||||
`compose.yaml` does not bundle PostgreSQL, AGE or pgAdmin: it runs the
|
||||
`apache/age` and `dpage/pgadmin4` images from Docker Hub, which come with their
|
||||
@@ -20,24 +20,24 @@ own license information.
|
||||
|
||||
| Component | License | Copyright | License text in the image |
|
||||
| --- | --- | --- | --- |
|
||||
| [neo4j-browser](https://github.com/neo4j/neo4j-browser), built unmodified from the commit pinned in the `Containerfile` | GPL-3.0-or-later | Neo4j Sweden AB | `/usr/share/doc/peo/neo4j-browser/` (`LICENSE`, `NOTICE.txt`) |
|
||||
| JavaScript libraries bundled into neo4j-browser | various (MIT, Apache-2.0, BSD, ...) | their respective authors | `/usr/share/doc/peo/neo4j-browser/LICENSES.txt` |
|
||||
| [Apache AGE](https://github.com/apache/age), from the `apache/age` base image | Apache-2.0 | The Apache Software Foundation; portions Bitnine Co., Ltd. | `/usr/share/doc/peo/apache-age/` (`LICENSE`, `NOTICE`) |
|
||||
| [neo4j-browser](https://github.com/neo4j/neo4j-browser), built unmodified from the commit pinned in the `Containerfile` | GPL-3.0-or-later | Neo4j Sweden AB | `/usr/share/doc/boltage/neo4j-browser/` (`LICENSE`, `NOTICE.txt`) |
|
||||
| JavaScript libraries bundled into neo4j-browser | various (MIT, Apache-2.0, BSD, ...) | their respective authors | `/usr/share/doc/boltage/neo4j-browser/LICENSES.txt` |
|
||||
| [Apache AGE](https://github.com/apache/age), from the `apache/age` base image | Apache-2.0 | The Apache Software Foundation; portions Bitnine Co., Ltd. | `/usr/share/doc/boltage/apache-age/` (`LICENSE`, `NOTICE`) |
|
||||
| [PostgreSQL](https://www.postgresql.org/), from the `apache/age` base image | PostgreSQL License | The PostgreSQL Global Development Group, The Regents of the University of California | `/usr/share/doc/postgresql-18/copyright` |
|
||||
| Debian GNU/Linux base system and packages, including Python 3 and `python3-psycopg` (LGPL-3.0) | various | their respective authors | `/usr/share/doc/<package>/copyright` |
|
||||
| Python packages peo depends on, installed from PyPI: `websockets` (BSD-3-Clause), `starlette` (BSD-3-Clause), `uvicorn` (BSD-3-Clause) and their dependencies | various (BSD-3-Clause, MIT, PSF-2.0) | their respective authors | `*.dist-info/` under `/opt/peo/venv/lib/python3*/site-packages/`, or `/usr/share/doc/peo/peo-python-licenses/` for packages whose wheel lacks a license file |
|
||||
| Python packages boltage depends on, installed from PyPI: `websockets` (BSD-3-Clause), `starlette` (BSD-3-Clause), `uvicorn` (BSD-3-Clause) and their dependencies | various (BSD-3-Clause, MIT, PSF-2.0) | their respective authors | `*.dist-info/` under `/opt/boltage/venv/lib/python3*/site-packages/`, or `/usr/share/doc/boltage/boltage-python-licenses/` for packages whose wheel lacks a license file |
|
||||
| [pgAdmin 4](https://www.pgadmin.org/), installed from PyPI | PostgreSQL License | The pgAdmin Development Team | `/opt/pgadmin/app/LICENSE` |
|
||||
| Python packages pgAdmin depends on, and `gunicorn` (MIT) | various | their respective authors | `*.dist-info/` under `/opt/pgadmin/lib/python3*/site-packages/`, or `/usr/share/doc/peo/pgadmin-python-licenses/` for packages whose wheel lacks a license file |
|
||||
| Python packages pgAdmin depends on, and `gunicorn` (MIT) | various | their respective authors | `*.dist-info/` under `/opt/pgadmin/lib/python3*/site-packages/`, or `/usr/share/doc/boltage/pgadmin-python-licenses/` for packages whose wheel lacks a license file |
|
||||
|
||||
## Source code
|
||||
|
||||
- **neo4j-browser** is licensed under the GPL, which requires the complete
|
||||
corresponding source to accompany the built application. The image contains
|
||||
it as `/usr/share/doc/peo/neo4j-browser/neo4j-browser-source.tar.gz`, an
|
||||
it as `/usr/share/doc/boltage/neo4j-browser/neo4j-browser-source.tar.gz`, an
|
||||
archive of the exact commit that was built. Its dependencies are pinned by
|
||||
the `yarn.lock` inside that archive, and the build steps are in this
|
||||
repository's `Containerfile`.
|
||||
- **peo** itself ships as Python source code in the `/opt/peo/venv/`
|
||||
- **boltage** itself ships as Python source code in the `/opt/boltage/venv/`
|
||||
virtual environment, next to the Python packages it depends on. This
|
||||
repository has the rest.
|
||||
- **Debian packages:** source is available from
|
||||
@@ -45,7 +45,7 @@ own license information.
|
||||
|
||||
## Interoperability
|
||||
|
||||
The peo bridge implements the Bolt protocol and PackStream format from their
|
||||
The boltage bridge implements the Bolt protocol and PackStream format from their
|
||||
public specifications so that unmodified Neo4j clients can connect. It contains
|
||||
no source code from Neo4j. To work with those clients it reports itself as
|
||||
"Neo4j" with a Neo4j version number, and it recognises the exact query strings
|
||||
@@ -57,5 +57,5 @@ strings to check compatibility.
|
||||
Neo4j is a trademark of Neo4j, Inc. PostgreSQL is a trademark of the PostgreSQL
|
||||
Community Association. Apache, Apache AGE and the Apache feather logo are
|
||||
trademarks of The Apache Software Foundation. pgAdmin is a trademark of the
|
||||
pgAdmin Development Team. peo is not affiliated with or endorsed by any of
|
||||
pgAdmin Development Team. boltage is not affiliated with or endorsed by any of
|
||||
them; the names are used only to identify the software it works with.
|
||||
Reference in new issue
Block a user