Skip to main content

FederatedCode is a decentralized, federated metadata system for open source software code and security information.

Quick Installation

Run with Docker

Clone FederatedCode:

git clone https://github.com/aboutcode-org/federatedcode.git
cd federatedcode

Build and run:

docker compose build
docker compose up

Local development installation

On a Debian system, use this:

sudo apt-get install python3-venv python3-dev postgresql libpq-dev build-essential
git clone https://github.com/aboutcode-org/federatedcode.git
cd federatedcode
make dev envfile postgresdb
make test
source venv/bin/activate
make run

Note that we support Python 3.10 and up only.

Configuration

The configuration of FederatedCode depends on environment variables:

  • FEDERATEDCODE_WORKSPACE_LOCATION: Directory location of the workspace where we store local Git repos and content. Default to var/ in current directory in development

  • These are generated id and secrets stored in a .env file when running make envfile - SECRET_KEY: Django’s secret key - FEDERATEDCODE_CLIENT_ID: Client UUID - FEDERATEDCODE_CLIENT_SECRET: Own secret key

Acknowledgements, Funding, Support and Sponsoring

This project is funded, supported and sponsored by:

  • Generous support and contributions from users like you!

  • the European Commission NGI programme

  • the NLnet Foundation

  • the Swiss State Secretariat for Education, Research and Innovation (SERI)

  • Google, including the Google Summer of Code and the Google Seasons of Doc programmes

  • Mercedes-Benz Group

  • Microsoft and Microsoft Azure

  • AboutCode ASBL

  • nexB Inc.

Europa logo EC DG Connect logo

NGI logo NLnet foundation logo

AboutCode logo nexB logo

This project was funded through the NGI0 PET Fund, a fund established by NLnet with financial support from the European Commission’s Next Generation Internet programme, under the aegis of DG Communications Networks, Content and Technology under grant agreement No 825310.

NGI Zero PET logo https://nlnet.nl/project/VulnerableCode/

This project was funded through the NGI0 Discovery Fund, a fund established by NLnet with financial support from the European Commission’s Next Generation Internet programme, under the aegis of DG Communications Networks, Content and Technology under grant agreement No 825322.

NGI Discovery logo https://nlnet.nl/project/vulnerabilitydatabase/

This project was funded through the NGI0 Core Fund, a fund established by NLnet with financial support from the European Commission’s Next Generation Internet programme, under the aegis of DG Communications Networks, Content and Technology under grant agreement No 101092990.

NGI Zero Core Logo https://nlnet.nl/project/VulnerableCode-enhancements/

This project is funded through the NGI0 Entrust Fund, a fund established by NLnet with financial support from the European Commission’s Next Generation Internet programme, under the aegis of DG Communications Networks, Content and Technology under grant agreement No 101069594.

NGI Zero Entrust logo https://nlnet.nl/project/FederatedSoftwareMetadata/

This project was funded through the NGI0 Commons Fund, a fund established by NLnet with financial support from the European Commission’s Next Generation Internet programme, under the aegis of DG Communications Networks, Content and Technology under grant agreement No 101135429. Additional funding is made available by the Swiss State Secretariat for Education, Research and Innovation (SERI).

NGI Zero Commons Logo Swiss logo https://nlnet.nl/project/FederatedCodeNext/

Metadata

Release files for federatedcode 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for federatedcode 0.1.0
File Size Uploaded Provenance Actions
federatedcode-0.1.0.tar.gz 61.7 kB Without provenance Details for federatedcode-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for federatedcode 0.1.0
File Interpreter ABI Platform Actions
federatedcode-0.1.0-py3-none-any.whl Python 3 none any Details for federatedcode-0.1.0-py3-none-any.whl

Total release size: 122.0 kB

Release files / federatedcode-0.1.0.tar.gz

Download URL federatedcode-0.1.0.tar.gz
Size 61.7 kB
Tags Source
SHA-256 checksum
How to use checksums
003bddb40fcc2607ae2a42f8f209c4a7e579a97cc44e34a985af3c5716b5cc18
BLAKE2b-256 checksum
How to use checksums
b433594956838672dc60047b705465606fdff156ab7a7de5b08191f6d909d699
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.12.8

Release files / federatedcode-0.1.0-py3-none-any.whl

Download URL federatedcode-0.1.0-py3-none-any.whl
Size 60.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
35a158ceef71de7380f243d8d1b229bb2156901fb7621405472a3864668a14ae
BLAKE2b-256 checksum
How to use checksums
b809dfc83a796753f456fe4aca21b1b85afade589f9ea234b5bda901e008d366
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.12.8

Security for federatedcode 0.1.0

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.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page