Repository files navigation

Fides (pronounced/fee-dhez/, from Latin: Fidēs) is an open-source privacy engineering platform for managing the fulfillment of data privacy requests in your runtime environment, and the enforcement of privacy regulations in your code.

In order to get started quickly with Fides, a sample project is bundled within the Fides CLI that will set up a server, privacy center, and a sample application for you to experiment with.

• Docker (version 20.10.11 or later)
• Python (version 3.9 through 3.10)

mkdir~/fidescd~/fidespython3 -m venv venvsource venv/bin/activate

Once your virtual environment is ready, you can easily download and install Fides usingpip. Run the following command to get started:

pip install ethyca-fides

By default, Fides ships with a small project belonging to a fictional e-commerce store. Running thefides deploy up command builds a Fides project with all you need to run your first Data Subject Request against real databases.

fides deploy up

When your deployment finishes, a welcome screen will explain the key components of Fides and the sample "Cookie House" project.

If your browser does not open automatically, you should navigate tohttp://localhost:3000/landing.

The project contains:

• The Fides Admin UI for managing privacy requests
• The FidesPrivacy Center for submitting requests
• The sample "Cookie House" eCommerce site for testing
• A DSR Directory on your computer to view results (./fides_uploads)

Navigate to the Fides Privacy Center (http://localhost:3001), submit a "Download your data" request, provide the email address for the sample user (jane@example.com), and submit the request.

Then, navigate to the Fides Admin UI (http://localhost:8080) to review the pending privacy request.

Use usernameroot_user and passwordTestpassword1! to login, approve the request, and review the resulting package in your./fides_uploads folder!

Congratulations! You've just run an entire privacy request in under 5 minutes! Fides offers many more tools to help take control of your data privacy. To find out more, you can run a privacy request onyour own infrastructure, discoverdata mapping, or learn about theFides Taxonomy.

The Fides core team is committed to providing a variety of documentation to help get you started using Fides. As such, all interactions are governed by theFides Code of Conduct.

For more information on getting started with Fides, how to configure and set up Fides, and more about the Fides ecosystem of open source projects:

• Documentation:https://ethyca.com/docs
• Website:www.ethyca.com/fides

Join the conversation on:

• Slack
• Twitter
• Discussions

We welcome and encourage all types of contributions and improvements! Please see ourcontribution guide to opening issues for bugs, new features, and security or experience enhancements.

Read about theFides community or dive into thecontributor guides for information about contributions, documentation, code style, testing and more. Ethyca is committed to fostering a safe and collaborative environment, such that all interactions are governed by theFides Code of Conduct.

TheFides ecosystem of tools are licensed under theApache Software License Version 2.0.Fides tools are built onfideslang, the Fides language specification, which is licensed underCC by 4.

Fides is created and sponsored by Ethyca: a developer tools company building the trust infrastructure of the internet. If you have questions or need assistance getting started, let us know atfides@ethyca.com!

By default, runningpip install ethyca-fides locally will not install the optional Python libraries needed for Microsoft SQL Server, since these rely on additional system dependencies (freetds)! However, if youdo want to connect to MSSQL, you have two options:

1. Use our pre-built Docker images which install these optional dependencies automatically:ethyca/fides. See ourDeployment Guide for more!
2. Install the required dependencies on your local development machine and runpip install "ethyca-fides[all]" to include "all" the optional libraries. Keep reading to learn more about this!

For local development setup on macOS, follow these steps:

1. Install the required development libraries from Homebrew:

brew install freetds openssl

2. Add the following to your shell (i.e..zshrc) to ensure your compiler can access thefreetds andopenssl libraries, updating the paths & versions to match your local install:

export LDFLAGS="-L/opt/homebrew/opt/freetds/lib -L/opt/homebrew/opt/openssl/lib"export CFLAGS="-I/opt/homebrew/opt/freetds/include"

3. Reinstall Fides with MSSQL support by including theall extra requirement:

pip install"ethyca-fides[all]"