README
¶
Cape
Cape Core contains the key functionality of Cape Privacy, including:
- A CLI (command line interface)
- Cape Coordinator, which provides policy management workflows, and controllers to work with the Cape Privacy libraries.
View the documentation.
Getting started
Cape Core comprises multiple elements, some of which interact with other parts of the Cape ecosystem. The following links point to the correct getting started resources for each element:
- Cape Coordinator installation guides
- Cape CLI installation guide
- Cape CLI usage guide
- Tutorial: using Coordinator and CLI with Cape Python
For information on how to work on Cape development locally, refer to Contributing.
About Cape Privacy and Cape
Cape Privacy helps teams share data and make decisions for safer and more powerful data science. Learn more at capeprivacy.com.
Cape contains the core functionality of Cape Privacy, including a CLI (command line interface), policy management workflow, and controllers to work with the Cape Privacy libraries.
Cape architecture
Cape is comprised of multiples services and libraries. The Coordinator provides policy and user management through a CLI. This in turn can interact with Cape's libraries, applying your data policy directly to the data transformation scripts.
Project status and roadmap
Cape Core was released 30th July 2020. It is actively maintained and developed, alongside other elements of the Cape ecosystem.
Upcoming features:
- Audit logging configuration: set up configuration for how and where you log actions in Cape Coordinator, such as project and policy creation, user changes and user actions in Cape.
- Governance tooling: integrate basic data governance information to be used within Cape Coordinator for writing better policy, with a possible integration with Apache Atlas or other open-source governance tools.
- Pipeline orchestrator integration: ability to connect with Spark orchestration tools (such as YARN, Mesos, and Airflow) and pull information on jobs that are running for easier management of running Spark installations.
The goal is a complete data management ecosystem. Cape Privacy provides Cape Coordinator, to manage policy and users. This will interact with the Cape Privacy libraries (such as Cape Python) through a workers interface, and with your own data services through an API.
Help and resources
If you need help using Cape, you can:
- View the documentation.
- Submit an issue.
- Talk to us on our community Slack.
Please file feature requests and bug reports as GitHub issues.
Community
Contributing
View our contributing guide for more information.
Code of conduct
Our code of conduct is included on the Cape Privacy website. All community members are expected to follow it. Please refer to that page for information on how to report problems.
License
Licensed under Apache License, Version 2.0 (see LICENSE or http://www.apache.org/licenses/LICENSE-2.0). Copyright as specified in NOTICE.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
cape/config
package config provides structs for holding, parsing, writing, and working with local configuration data for the command line tool.
|
package config provides structs for holding, parsing, writing, and working with local configuration data for the command line tool. |
|
cape/ui
package ui contains functionality for prompting for input, colorizing output, and creating animations.
|
package ui contains functionality for prompting for input, colorizing output, and creating animations. |
|
db/dbtest
dbtest contains functionality for writing tests
|
dbtest contains functionality for writing tests |
|
harness
package harness contains functionality for setting up and testing the coordinator in various different states.
|
package harness contains functionality for setting up and testing the coordinator in various different states. |
|
logging is a wrapper around rs/zerolog making it easier to create & manage
|
logging is a wrapper around rs/zerolog making it easier to create & manage |
|
Package mage contains re-usable and testable components for building, testing, and releasing Cape using Magefile
|
Package mage contains re-usable and testable components for building, testing, and releasing Cape using Magefile |
|
version contains build information that's set via ldflags during compilation.
|
version contains build information that's set via ldflags during compilation. |