ethyca-fides 2.73.1b0__tar.gz → 2.73.1rc0__tar.gz

ethyca_fides-2.73.1rc0/PKG-INFO

@@ -0,0 +1,261 @@
+Metadata-Version: 2.4
+Name: ethyca_fides
+Version: 2.73.1rc0
+Summary: Open-source ecosystem for data privacy as code.
+Home-page: https://github.com/ethyca/fides
+Author: Ethyca, Inc.
+Author-email: fidesteam@ethyca.com
+License: Apache License 2.0
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.9, <4
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: acryl-datahub==0.14.1
+Requires-Dist: alembic==1.8.1
+Requires-Dist: anyascii==0.3.2
+Requires-Dist: anyio==3.7.1
+Requires-Dist: APScheduler==3.9.1.post1
+Requires-Dist: asyncpg==0.27.0
+Requires-Dist: boto3==1.26.1
+Requires-Dist: certifi==2024.8.30
+Requires-Dist: celery[pytest]==5.5.3
+Requires-Dist: click==8.1.8
+Requires-Dist: click_default_group==1.2.2
+Requires-Dist: cloud-sql-python-connector==1.9.2
+Requires-Dist: colorama>=0.4.3
+Requires-Dist: cryptography==44.0.1
+Requires-Dist: dask==2022.9.2
+Requires-Dist: deepdiff==6.3.0
+Requires-Dist: defusedxml==0.7.1
+Requires-Dist: types-defusedxml==0.7.0.20240218
+Requires-Dist: expandvars==0.9.0
+Requires-Dist: fastapi[all]==0.115.2
+Requires-Dist: fastapi-pagination[sqlalchemy]==0.12.25
+Requires-Dist: fideslog==1.2.14
+Requires-Dist: firebase-admin==5.3.0
+Requires-Dist: flower==2.0.1
+Requires-Dist: GitPython==3.1.41
+Requires-Dist: httpx==0.23.1
+Requires-Dist: onepassword-sdk==0.3.0
+Requires-Dist: iab-tcf==0.2.2
+Requires-Dist: immutables==0.20
+Requires-Dist: importlib_resources==5.12.0
+Requires-Dist: Jinja2==3.1.5
+Requires-Dist: joblib==1.3.2
+Requires-Dist: loguru==0.6.0
+Requires-Dist: multidimensional_urlencode==0.0.4
+Requires-Dist: pg8000==1.31.2
+Requires-Dist: nh3==0.2.15
+Requires-Dist: numpy==1.24.4
+Requires-Dist: oauthlib==3.3.1
+Requires-Dist: okta==2.7.0
+Requires-Dist: openpyxl==3.0.9
+Requires-Dist: networkx==3.1
+Requires-Dist: packaging==23.0
+Requires-Dist: pandas==1.4.3
+Requires-Dist: paramiko==3.4.1
+Requires-Dist: passlib[bcrypt]==1.7.4
+Requires-Dist: pyinstrument==4.5.1
+Requires-Dist: psycopg2-binary==2.9.6
+Requires-Dist: pydantic==2.7.1
+Requires-Dist: pydantic-settings==2.3.3
+Requires-Dist: pydash==6.0.2
+Requires-Dist: pygtrie==2.5.0
+Requires-Dist: PyJWT==2.4.0
+Requires-Dist: pymongo[srv]==4.7.3
+Requires-Dist: PyMySQL==1.1.1
+Requires-Dist: python-jose[cryptography]==3.3.0
+Requires-Dist: pyyaml==6.0.1
+Requires-Dist: pyahocorasick==2.1.0
+Requires-Dist: redis==3.5.3
+Requires-Dist: requests-oauthlib==2.0.0
+Requires-Dist: rich-click==1.6.1
+Requires-Dist: sendgrid==6.9.7
+Requires-Dist: scylla-driver==3.26.8
+Requires-Dist: slowapi==0.1.9
+Requires-Dist: smart-open[gcs,s3]==7.3.0.post1
+Requires-Dist: snowflake-sqlalchemy==1.5.1
+Requires-Dist: sqlalchemy[asyncio]==1.4.27
+Requires-Dist: sqlalchemy-citext==1.8.0
+Requires-Dist: sqlalchemy-bigquery==1.7.0
+Requires-Dist: sqlalchemy-redshift==0.8.11
+Requires-Dist: sqlalchemy-stubs==0.4
+Requires-Dist: SQLAlchemy-Utils==0.38.3
+Requires-Dist: sshtunnel==0.4.0
+Requires-Dist: stream-zip==0.0.83
+Requires-Dist: tinycss2==1.2.1
+Requires-Dist: toml==0.10.2
+Requires-Dist: twilio==7.15.0
+Requires-Dist: typing-extensions==4.12.2
+Requires-Dist: versioneer==0.19
+Requires-Dist: fideslang==3.1.2
+Provides-Extra: mssql
+Requires-Dist: pymssql==2.3.7; extra == "mssql"
+Provides-Extra: all
+Requires-Dist: pymssql==2.3.7; extra == "all"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Meet Fides: Privacy as Code
+
+[![Latest Release Version][release-image]][release-url]
+[![Docker][docker-workflow-image]][docker-actions-url]
+[![Docs][docs-workflow-image]][docs-actions-url]
+[![Package][release-workflow-image]][publish-actions-url]
+[![License][license-image]][license-url]
+[![Code style: black][black-image]][black-url]
+[![Checked with mypy][mypy-image]][mypy-url]
+[![Twitter][twitter-image]][twitter-url]
+[![Coverage](https://codecov.io/github/ethyca/fides/coverage.svg?branch=main)](https://codecov.io/gh/ethyca/fides)
+
+![Fides banner](docs/fides/docs/img/fides-banner.png "Fides banner")
+
+## :zap: Overview
+
+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.
+
+## :rocket: Quick Start
+
+### Getting Started
+
+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.
+
+#### Minimum requirements (for all platforms)
+
+* [Docker](https://www.docker.com/products/docker-desktop) (version 20.10.11 or later)
+* [Python](https://www.python.org/downloads/) (version 3.9 through 3.10)
+
+#### Download and install Fides
+
+> [!TIP]
+> We highly recommend setting up a Python virtual environment such as `venv` to install Fides into. For example:
+>
+> ```sh
+> mkdir ~/fides
+> cd ~/fides
+> python3 -m venv venv
+> source venv/bin/activate
+> ```
+
+Once your virtual environment is ready, you can easily download and install Fides using `pip`. Run the following command to get started:
+
+```
+pip install ethyca-fides
+```
+
+#### Deploy the Fides sample project
+
+By default, Fides ships with a small project belonging to a fictional e-commerce store. Running the `fides deploy up` command builds a Fides project with all you need to run your first Data Subject Request against real databases.
+
+```sh
+fides deploy up
+```
+
+#### Explore the sample project
+
+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 to <http://localhost:3000/landing>.
+
+The project contains:
+
+* The Fides Admin UI for managing privacy requests
+* The Fides [Privacy Center](https://ethyca.com/docs/dev-docs/privacy-requests/privacy-center) for submitting requests
+* The sample "Cookie House" eCommerce site for testing
+* A DSR Directory on your computer to view results (`./fides_uploads`)
+
+#### Run your first Privacy Access Request
+
+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 username `root_user` and password `Testpassword1!` to login, approve the request, and review the resulting package in your `./fides_uploads` folder!
+
+### Next Steps
+
+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 on [your own infrastructure](https://ethyca.com/docs/tutorials/privacy-requests), discover [data mapping](https://ethyca.com/docs/tutorials/data-mapping), or learn about the [Fides Taxonomy](https://ethyca.github.io/fideslang/).
+
+## :book: Learn More
+
+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 the [Fides Code of Conduct](https://ethyca.com/docs/community/code_of_conduct).
+
+### Documentation
+
+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
+
+### Support
+
+Join the conversation on:
+
+* [Slack](https://fid.es/join-slack)
+* [Twitter](https://twitter.com/ethyca)
+* [Discussions](https://github.com/ethyca/fides/discussions)
+
+### Contributing
+
+We welcome and encourage all types of contributions and improvements!  Please see our [contribution guide](https://ethyca.com/docs/community) to opening issues for bugs, new features, and security or experience enhancements.
+
+Read about the [Fides community](https://ethyca.com/docs/community/hints_tips) or dive into the [contributor guides](https://ethyca.com/docs/community/development/overview) 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 the [Fides Code of Conduct](https://ethyca.com/docs/community/code_of_conduct).
+
+## :balance_scale: License
+
+The [Fides](https://github.com/ethyca/fides) ecosystem of tools are licensed under the [Apache Software License Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).
+Fides tools are built on [fideslang](https://github.com/ethyca/privacy-taxonomy), the Fides language specification, which is licensed under [CC by 4](https://github.com/ethyca/privacy-taxonomy/blob/main/LICENSE).
+
+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 at fides@ethyca.com!
+
+[release-image]: https://img.shields.io/github/release/ethyca/fides.svg
+[release-url]: https://github.com/ethyca/fides/releases
+[docker-workflow-image]: https://github.com/ethyca/fides/workflows/Docker%20Build%20&%20Push/badge.svg
+[docs-workflow-image]: https://github.com/ethyca/fides/workflows/Publish%20Docs/badge.svg
+[release-workflow-image]: https://github.com/ethyca/fides/actions/workflows/publish_package.yaml/badge.svg
+[docker-actions-url]: https://github.com/ethyca/fides/actions/workflows/publish_docker.yaml
+[docs-actions-url]: https://github.com/ethyca/fides/actions/workflows/publish_docs.yaml
+[publish-actions-url]: https://github.com/ethyca/fides/actions/workflows/publish_package.yaml
+[license-image]: https://img.shields.io/:license-Apache%202-blue.svg
+[license-url]: https://www.apache.org/licenses/LICENSE-2.0.txt
+[black-image]: https://img.shields.io/badge/code%20style-black-000000.svg
+[black-url]: https://github.com/psf/black/
+[mypy-image]: http://www.mypy-lang.org/static/mypy_badge.svg
+[mypy-url]: http://mypy-lang.org/
+[twitter-image]: https://img.shields.io/twitter/follow/ethyca?style=social
+[twitter-url]: https://twitter.com/ethyca
+
+## ⚠️ Advanced Setup for Microsoft SQL Server (MSSQL) Support
+
+By default, running `pip 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 you *do* want to connect to MSSQL, you have two options:
+1. Use our pre-built Docker images which install these optional dependencies automatically: [`ethyca/fides`](https://hub.docker.com/r/ethyca/fides). See our [Deployment Guide](https://ethyca.com/docs/dev-docs/configuration/deployment) for more!
+2. Install the required dependencies on your local development machine and run `pip 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:
+```zsh
+brew install freetds openssl
+```
+2. Add the following to your shell (i.e. `.zshrc`) to ensure your compiler can access the `freetds` and `openssl` libraries, updating the paths & versions to match your local install:
+```zsh
+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 the `all` extra requirement:
+```zsh
+pip install "ethyca-fides[all]"
+```

ethyca_fides-2.73.1rc0/src/ethyca_fides.egg-info/PKG-INFO

@@ -0,0 +1,261 @@
+Metadata-Version: 2.4
+Name: ethyca_fides
+Version: 2.73.1rc0
+Summary: Open-source ecosystem for data privacy as code.
+Home-page: https://github.com/ethyca/fides
+Author: Ethyca, Inc.
+Author-email: fidesteam@ethyca.com
+License: Apache License 2.0
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.9, <4
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: acryl-datahub==0.14.1
+Requires-Dist: alembic==1.8.1
+Requires-Dist: anyascii==0.3.2
+Requires-Dist: anyio==3.7.1
+Requires-Dist: APScheduler==3.9.1.post1
+Requires-Dist: asyncpg==0.27.0
+Requires-Dist: boto3==1.26.1
+Requires-Dist: certifi==2024.8.30
+Requires-Dist: celery[pytest]==5.5.3
+Requires-Dist: click==8.1.8
+Requires-Dist: click_default_group==1.2.2
+Requires-Dist: cloud-sql-python-connector==1.9.2
+Requires-Dist: colorama>=0.4.3
+Requires-Dist: cryptography==44.0.1
+Requires-Dist: dask==2022.9.2
+Requires-Dist: deepdiff==6.3.0
+Requires-Dist: defusedxml==0.7.1
+Requires-Dist: types-defusedxml==0.7.0.20240218
+Requires-Dist: expandvars==0.9.0
+Requires-Dist: fastapi[all]==0.115.2
+Requires-Dist: fastapi-pagination[sqlalchemy]==0.12.25
+Requires-Dist: fideslog==1.2.14
+Requires-Dist: firebase-admin==5.3.0
+Requires-Dist: flower==2.0.1
+Requires-Dist: GitPython==3.1.41
+Requires-Dist: httpx==0.23.1
+Requires-Dist: onepassword-sdk==0.3.0
+Requires-Dist: iab-tcf==0.2.2
+Requires-Dist: immutables==0.20
+Requires-Dist: importlib_resources==5.12.0
+Requires-Dist: Jinja2==3.1.5
+Requires-Dist: joblib==1.3.2
+Requires-Dist: loguru==0.6.0
+Requires-Dist: multidimensional_urlencode==0.0.4
+Requires-Dist: pg8000==1.31.2
+Requires-Dist: nh3==0.2.15
+Requires-Dist: numpy==1.24.4
+Requires-Dist: oauthlib==3.3.1
+Requires-Dist: okta==2.7.0
+Requires-Dist: openpyxl==3.0.9
+Requires-Dist: networkx==3.1
+Requires-Dist: packaging==23.0
+Requires-Dist: pandas==1.4.3
+Requires-Dist: paramiko==3.4.1
+Requires-Dist: passlib[bcrypt]==1.7.4
+Requires-Dist: pyinstrument==4.5.1
+Requires-Dist: psycopg2-binary==2.9.6
+Requires-Dist: pydantic==2.7.1
+Requires-Dist: pydantic-settings==2.3.3
+Requires-Dist: pydash==6.0.2
+Requires-Dist: pygtrie==2.5.0
+Requires-Dist: PyJWT==2.4.0
+Requires-Dist: pymongo[srv]==4.7.3
+Requires-Dist: PyMySQL==1.1.1
+Requires-Dist: python-jose[cryptography]==3.3.0
+Requires-Dist: pyyaml==6.0.1
+Requires-Dist: pyahocorasick==2.1.0
+Requires-Dist: redis==3.5.3
+Requires-Dist: requests-oauthlib==2.0.0
+Requires-Dist: rich-click==1.6.1
+Requires-Dist: sendgrid==6.9.7
+Requires-Dist: scylla-driver==3.26.8
+Requires-Dist: slowapi==0.1.9
+Requires-Dist: smart-open[gcs,s3]==7.3.0.post1
+Requires-Dist: snowflake-sqlalchemy==1.5.1
+Requires-Dist: sqlalchemy[asyncio]==1.4.27
+Requires-Dist: sqlalchemy-citext==1.8.0
+Requires-Dist: sqlalchemy-bigquery==1.7.0
+Requires-Dist: sqlalchemy-redshift==0.8.11
+Requires-Dist: sqlalchemy-stubs==0.4
+Requires-Dist: SQLAlchemy-Utils==0.38.3
+Requires-Dist: sshtunnel==0.4.0
+Requires-Dist: stream-zip==0.0.83
+Requires-Dist: tinycss2==1.2.1
+Requires-Dist: toml==0.10.2
+Requires-Dist: twilio==7.15.0
+Requires-Dist: typing-extensions==4.12.2
+Requires-Dist: versioneer==0.19
+Requires-Dist: fideslang==3.1.2
+Provides-Extra: mssql
+Requires-Dist: pymssql==2.3.7; extra == "mssql"
+Provides-Extra: all
+Requires-Dist: pymssql==2.3.7; extra == "all"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Meet Fides: Privacy as Code
+
+[![Latest Release Version][release-image]][release-url]
+[![Docker][docker-workflow-image]][docker-actions-url]
+[![Docs][docs-workflow-image]][docs-actions-url]
+[![Package][release-workflow-image]][publish-actions-url]
+[![License][license-image]][license-url]
+[![Code style: black][black-image]][black-url]
+[![Checked with mypy][mypy-image]][mypy-url]
+[![Twitter][twitter-image]][twitter-url]
+[![Coverage](https://codecov.io/github/ethyca/fides/coverage.svg?branch=main)](https://codecov.io/gh/ethyca/fides)
+
+![Fides banner](docs/fides/docs/img/fides-banner.png "Fides banner")
+
+## :zap: Overview
+
+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.
+
+## :rocket: Quick Start
+
+### Getting Started
+
+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.
+
+#### Minimum requirements (for all platforms)
+
+* [Docker](https://www.docker.com/products/docker-desktop) (version 20.10.11 or later)
+* [Python](https://www.python.org/downloads/) (version 3.9 through 3.10)
+
+#### Download and install Fides
+
+> [!TIP]
+> We highly recommend setting up a Python virtual environment such as `venv` to install Fides into. For example:
+>
+> ```sh
+> mkdir ~/fides
+> cd ~/fides
+> python3 -m venv venv
+> source venv/bin/activate
+> ```
+
+Once your virtual environment is ready, you can easily download and install Fides using `pip`. Run the following command to get started:
+
+```
+pip install ethyca-fides
+```
+
+#### Deploy the Fides sample project
+
+By default, Fides ships with a small project belonging to a fictional e-commerce store. Running the `fides deploy up` command builds a Fides project with all you need to run your first Data Subject Request against real databases.
+
+```sh
+fides deploy up
+```
+
+#### Explore the sample project
+
+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 to <http://localhost:3000/landing>.
+
+The project contains:
+
+* The Fides Admin UI for managing privacy requests
+* The Fides [Privacy Center](https://ethyca.com/docs/dev-docs/privacy-requests/privacy-center) for submitting requests
+* The sample "Cookie House" eCommerce site for testing
+* A DSR Directory on your computer to view results (`./fides_uploads`)
+
+#### Run your first Privacy Access Request
+
+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 username `root_user` and password `Testpassword1!` to login, approve the request, and review the resulting package in your `./fides_uploads` folder!
+
+### Next Steps
+
+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 on [your own infrastructure](https://ethyca.com/docs/tutorials/privacy-requests), discover [data mapping](https://ethyca.com/docs/tutorials/data-mapping), or learn about the [Fides Taxonomy](https://ethyca.github.io/fideslang/).
+
+## :book: Learn More
+
+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 the [Fides Code of Conduct](https://ethyca.com/docs/community/code_of_conduct).
+
+### Documentation
+
+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
+
+### Support
+
+Join the conversation on:
+
+* [Slack](https://fid.es/join-slack)
+* [Twitter](https://twitter.com/ethyca)
+* [Discussions](https://github.com/ethyca/fides/discussions)
+
+### Contributing
+
+We welcome and encourage all types of contributions and improvements!  Please see our [contribution guide](https://ethyca.com/docs/community) to opening issues for bugs, new features, and security or experience enhancements.
+
+Read about the [Fides community](https://ethyca.com/docs/community/hints_tips) or dive into the [contributor guides](https://ethyca.com/docs/community/development/overview) 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 the [Fides Code of Conduct](https://ethyca.com/docs/community/code_of_conduct).
+
+## :balance_scale: License
+
+The [Fides](https://github.com/ethyca/fides) ecosystem of tools are licensed under the [Apache Software License Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).
+Fides tools are built on [fideslang](https://github.com/ethyca/privacy-taxonomy), the Fides language specification, which is licensed under [CC by 4](https://github.com/ethyca/privacy-taxonomy/blob/main/LICENSE).
+
+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 at fides@ethyca.com!
+
+[release-image]: https://img.shields.io/github/release/ethyca/fides.svg
+[release-url]: https://github.com/ethyca/fides/releases
+[docker-workflow-image]: https://github.com/ethyca/fides/workflows/Docker%20Build%20&%20Push/badge.svg
+[docs-workflow-image]: https://github.com/ethyca/fides/workflows/Publish%20Docs/badge.svg
+[release-workflow-image]: https://github.com/ethyca/fides/actions/workflows/publish_package.yaml/badge.svg
+[docker-actions-url]: https://github.com/ethyca/fides/actions/workflows/publish_docker.yaml
+[docs-actions-url]: https://github.com/ethyca/fides/actions/workflows/publish_docs.yaml
+[publish-actions-url]: https://github.com/ethyca/fides/actions/workflows/publish_package.yaml
+[license-image]: https://img.shields.io/:license-Apache%202-blue.svg
+[license-url]: https://www.apache.org/licenses/LICENSE-2.0.txt
+[black-image]: https://img.shields.io/badge/code%20style-black-000000.svg
+[black-url]: https://github.com/psf/black/
+[mypy-image]: http://www.mypy-lang.org/static/mypy_badge.svg
+[mypy-url]: http://mypy-lang.org/
+[twitter-image]: https://img.shields.io/twitter/follow/ethyca?style=social
+[twitter-url]: https://twitter.com/ethyca
+
+## ⚠️ Advanced Setup for Microsoft SQL Server (MSSQL) Support
+
+By default, running `pip 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 you *do* want to connect to MSSQL, you have two options:
+1. Use our pre-built Docker images which install these optional dependencies automatically: [`ethyca/fides`](https://hub.docker.com/r/ethyca/fides). See our [Deployment Guide](https://ethyca.com/docs/dev-docs/configuration/deployment) for more!
+2. Install the required dependencies on your local development machine and run `pip 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:
+```zsh
+brew install freetds openssl
+```
+2. Add the following to your shell (i.e. `.zshrc`) to ensure your compiler can access the `freetds` and `openssl` libraries, updating the paths & versions to match your local install:
+```zsh
+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 the `all` extra requirement:
+```zsh
+pip install "ethyca-fides[all]"
+```