BGC Viewer
A viewer for biosynthetic gene cluster (BGC) data.
Installation & run
Using Python 3.11 or higher, install and run the BGC Viewer as follows:
pip install bgc-viewer
bgc-viewer
This will start the BGC Viewer server, to which you can connect with your web browser.
Configuration
Environment variables can be set to change the configuration of the viewer.
A convenient way to change them is to put a file called .env in the directory from
which you are running the application.
Basic Configuration
BGCV_HOST=localhost # Server host (default: localhost)
BGCV_PORT=5005 # Server port (default: 5005)
BGCV_DEBUG_MODE=false # Enable dev/debug mode (default: false)
Public Mode (Multi-user Deployment)
BGCV_PUBLIC_MODE=true # Enable public mode
BGCV_INDEX_FILENAME=attributes.db # Index database filename (default: attributes.db)
BGCV_SECRET_KEY=your-secret-key # Secret key for session signing (required)
REDIS_URL=redis://localhost:6379 # Redis URL for session storage (recommended)
HTTPS_ENABLED=true # Enable secure cookies for HTTPS
BGCV_ALLOWED_ORIGINS=https://yourdomain.com # Allowed CORS origins
In public mode:
- The index database file is expected at
/index/(mounted volume in Docker) - The data files are expected at
/data_root/(mounted volume in Docker) - Multiple users can access the application simultaneously with session support
- File system browsing and preprocessing endpoints are disabled
For more configuration options, see .env.example.
Development
See the repository main README for development details.
uv run python -m bgc_viewer.app
License
Apache 2.0
2 maintainers
Metadata
2 maintainers
Release files for bgc-viewer 0.3.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| bgc_viewer-0.3.4.tar.gz | 29.8 kB | Details |
Built distributions (wheels)
| File | Reset | |||
|---|---|---|---|---|
| bgc_viewer-0.3.4-cp313-cp313-win_amd64.whl | CPython 3.13 | CPython 3.13 | Windows x86-64 | Details |
| bgc_viewer-0.3.4-cp313-cp313-manylinux_2_34_x86_64.whl | CPython 3.13 | CPython 3.13 | Linux glibc 2.34+ x86-64 | Details |
| bgc_viewer-0.3.4-cp313-cp313-macosx_11_0_arm64.whl | CPython 3.13 | CPython 3.13 | macOS 11.0+ ARM64 | Details |
| bgc_viewer-0.3.4-cp312-cp312-win_amd64.whl | CPython 3.12 | CPython 3.12 | Windows x86-64 | Details |
| bgc_viewer-0.3.4-cp312-cp312-manylinux_2_34_x86_64.whl | CPython 3.12 | CPython 3.12 | Linux glibc 2.34+ x86-64 | Details |
| bgc_viewer-0.3.4-cp312-cp312-macosx_11_0_arm64.whl | CPython 3.12 | CPython 3.12 | macOS 11.0+ ARM64 | Details |
| bgc_viewer-0.3.4-cp311-cp311-win_amd64.whl | CPython 3.11 | CPython 3.11 | Windows x86-64 | Details |
| bgc_viewer-0.3.4-cp311-cp311-manylinux_2_34_x86_64.whl | CPython 3.11 | CPython 3.11 | Linux glibc 2.34+ x86-64 | Details |
| bgc_viewer-0.3.4-cp311-cp311-macosx_11_0_arm64.whl | CPython 3.11 | CPython 3.11 | macOS 11.0+ ARM64 | Details |
Total release size: 4.3 MB
Release files / bgc_viewer-0.3.4.tar.gz
| Download URL | bgc_viewer-0.3.4.tar.gz |
|---|---|
| Size | 29.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7d25432c60198a0f1125a7e212e699b24f349947a5b5c8639c5b794d765b1637
|
|
BLAKE2b-256 checksum How to use checksums |
14dab8167537d4502d700a85ecc0ca29267f2742029a2998fc86265700093bf4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 23, 2026.
Transparency logRelease files / bgc_viewer-0.3.4-cp313-cp313-win_amd64.whl
| Download URL | bgc_viewer-0.3.4-cp313-cp313-win_amd64.whl |
|---|---|
| Size | 404.8 kB |
| Tags | CPython 3.13 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
7f36419a00f3da0d1a9472cf2873570668b2780c5b959f6756e95630e11a5e4d
|
|
BLAKE2b-256 checksum How to use checksums |
fd4338f851224b8d86a6c7bd50bd31f948375347b4a741d0fc103a90979d8bce
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 23, 2026.
Transparency logRelease files / bgc_viewer-0.3.4-cp313-cp313-manylinux_2_34_x86_64.whl
| Download URL | bgc_viewer-0.3.4-cp313-cp313-manylinux_2_34_x86_64.whl |
|---|---|
| Size | 531.7 kB |
| Tags | CPython 3.13 Linux glibc 2.34+ x86-64 |
|
SHA-256 checksum How to use checksums |
9bb74d4b51dfcaab1951381451b7254fcce1994ec6ca2773e1a58e5042f7d343
|
|
BLAKE2b-256 checksum How to use checksums |
e802168ee3c4f26deb01b21229d0b3b2c02a1b32ea4b47d65fe4a4135cff82cc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 23, 2026.
Transparency logRelease files / bgc_viewer-0.3.4-cp313-cp313-macosx_11_0_arm64.whl
| Download URL | bgc_viewer-0.3.4-cp313-cp313-macosx_11_0_arm64.whl |
|---|---|
| Size | 498.2 kB |
| Tags | CPython 3.13 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
234166d2cfda9ef955c0a9d01e562ab44516bbdde00b9de179e985832e141218
|
|
BLAKE2b-256 checksum How to use checksums |
4182951d81ee816e6c995e8d2d883339d65abce6a1d2ed05e7ed33cadc503b90
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 23, 2026.
Transparency logRelease files / bgc_viewer-0.3.4-cp312-cp312-win_amd64.whl
| Download URL | bgc_viewer-0.3.4-cp312-cp312-win_amd64.whl |
|---|---|
| Size | 404.9 kB |
| Tags | CPython 3.12 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
c408c2cc5b5078e7b459093972e333c096d8f737129b7a44ca6b0455dc9a2892
|
|
BLAKE2b-256 checksum How to use checksums |
cf42fc8db145f4ebcc079bb636b4069c850018f993d9fc719089b11cdf05e888
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 23, 2026.
Transparency logRelease files / bgc_viewer-0.3.4-cp312-cp312-manylinux_2_34_x86_64.whl
| Download URL | bgc_viewer-0.3.4-cp312-cp312-manylinux_2_34_x86_64.whl |
|---|---|
| Size | 532.0 kB |
| Tags | CPython 3.12 Linux glibc 2.34+ x86-64 |
|
SHA-256 checksum How to use checksums |
0fa16d66966f606a3d5f2c6aace44e433907fd0bd9a9b61e2bca17f5f228ce3e
|
|
BLAKE2b-256 checksum How to use checksums |
666c0ef55fd89591fd3b8847ffa50667f9d10cd3ee24f99fbfb5653b81a577ad
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 23, 2026.
Transparency logRelease files / bgc_viewer-0.3.4-cp312-cp312-macosx_11_0_arm64.whl
| Download URL | bgc_viewer-0.3.4-cp312-cp312-macosx_11_0_arm64.whl |
|---|---|
| Size | 498.3 kB |
| Tags | CPython 3.12 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
c97867b1a88dc3dd6c56b81368c7b40b25efb11f31e8bdfdffc16020f1ed1004
|
|
BLAKE2b-256 checksum How to use checksums |
dcc801916676685ca8756bc16ba526968ffe9de71ae235e07848b81ce5c7c0d9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 23, 2026.
Transparency logRelease files / bgc_viewer-0.3.4-cp311-cp311-win_amd64.whl
| Download URL | bgc_viewer-0.3.4-cp311-cp311-win_amd64.whl |
|---|---|
| Size | 404.7 kB |
| Tags | CPython 3.11 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
a5b15710d5915e5de77a4d3f9a1f7392f4b8398443529cf0c624a04d0df02e5d
|
|
BLAKE2b-256 checksum How to use checksums |
e1c1b2432c67bd1ea1e7b32878c647e550781f844e736cd284fd648585bc5e3d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 23, 2026.
Transparency logRelease files / bgc_viewer-0.3.4-cp311-cp311-manylinux_2_34_x86_64.whl
| Download URL | bgc_viewer-0.3.4-cp311-cp311-manylinux_2_34_x86_64.whl |
|---|---|
| Size | 532.0 kB |
| Tags | CPython 3.11 Linux glibc 2.34+ x86-64 |
|
SHA-256 checksum How to use checksums |
1b004c194fd310072bb9cc0fe7be11b7c5888a1e6e9b3d01561891e2199e5727
|
|
BLAKE2b-256 checksum How to use checksums |
b1f137b7a8486c4a25dc4f8d34f238f819cd9da2b6b0f9b2a2521ff2df69c297
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 23, 2026.
Transparency logRelease files / bgc_viewer-0.3.4-cp311-cp311-macosx_11_0_arm64.whl
| Download URL | bgc_viewer-0.3.4-cp311-cp311-macosx_11_0_arm64.whl |
|---|---|
| Size | 498.5 kB |
| Tags | CPython 3.11 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
3288dfd83a23bbcb0bcb5f2ab946ff774205cef00d96dbd45b364b1fe6c686b2
|
|
BLAKE2b-256 checksum How to use checksums |
e632f88e1809f3dfcf081db46bd0babfe5254b19f320715f9e0709a5b6b3d6e1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 23, 2026.
Transparency log
