Finish renaming lib (#142)

* rename lib files

* rename lib in source code

.coveragerc

@@ -1,4 +1,4 @@
 [report]
 omit=
-    cape_privacy/spark/examples/*
+    cape_dataframes/spark/examples/*
     *test.py

Makefile

@@ -55,7 +55,7 @@ bootstrap:
 test:
 	pytest
 
-CI_FILES=cape_privacy/pandas cape_privacy/spark cape_privacy/policy cape_privacy/coordinator
+CI_FILES=cape_dataframes/pandas cape_dataframes/spark cape_dataframes/policy cape_dataframes/coordinator
 
 lint:
 	flake8 .
@@ -67,7 +67,7 @@ fmt:
 	black .
 
 coverage:
-	pytest --cov-report=xml --cov=cape_privacy ${CI_FILES}
+	pytest --cov-report=xml --cov=cape_dataframes ${CI_FILES}
 	coverage report --fail-under=90
 
 examples:

README.md

@@ -1,6 +1,6 @@
 # Cape Dataframes
 
-![](https://github.com/capeprivacy/cape-python/workflows/Main/badge.svg) 
+[![](https://github.com/capeprivacy/cape-dataframes/workflows/Main/badge.svg)](https://github.com/capeprivacy/cape-dataframes/actions/workflows/main.yml)
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) 
 [![codecov](https://codecov.io/gh/capeprivacy/cape-python/branch/master/graph/badge.svg?token=L9A8HFAJK5)](https://codecov.io/gh/capeprivacy/cape-python)
 [![PyPI version](https://badge.fury.io/py/cape-privacy.svg)](https://badge.fury.io/py/cape-privacy)
@@ -24,13 +24,13 @@ See below for instructions on how to get started or visit the [documentation](ht
 Cape Dataframes is available through PyPi.
 
 ```sh
-pip install cape-privacy
+pip install cape-dataframes
 ```
 
 Support for Apache Spark is optional.  If you plan on using the library together with Apache Spark, we suggest the following instead:
 
 ```sh
-pip install cape-privacy[spark]
+pip install cape-dataframes[spark]
 ```
 
 We recommend running it in a virtual environment, such as [venv](https://docs.python.org/3/library/venv.html).
@@ -147,5 +147,3 @@ Our [code of conduct](https://capeprivacy.com/conduct/) is included on the Cape
 ## License
 
 Licensed under Apache License, Version 2.0 (see [LICENSE](https://github.com/capeprivacy/cape-python/blob/master/LICENSE) or http://www.apache.org/licenses/LICENSE-2.0). Copyright as specified in [NOTICE](https://github.com/capeprivacy/cape-python/blob/master/NOTICE).
-
-

cape_dataframes/__init__.py

@@ -0,0 +1,7 @@
+from cape_dataframes import pandas
+from cape_dataframes import spark
+from cape_dataframes.coordinator import Client
+from cape_dataframes.policy.policy import apply_policy
+from cape_dataframes.policy.policy import parse_policy
+
+__all__ = ["apply_policy", "pandas", "parse_policy", "spark", "Client"]

cape_dataframes/audit/__init__.py

@@ -0,0 +1,4 @@
+from cape_dataframes.audit.audit import APPLY_POLICY_EVENT
+from cape_dataframes.audit.audit import AuditLogger
+
+__all__ = ["AuditLogger", "APPLY_POLICY_EVENT"]

cape_dataframes/coordinator/__init__.py

@@ -0,0 +1,3 @@
+from cape_dataframes.coordinator.client import Client
+
+__all__ = ["Client"]

cape_privacy/coordinator/auth/api_token.py → cape_dataframes/coordinator/auth/api_token.py

@@ -1,4 +1,4 @@
-from cape_privacy.utils import base64
+from cape_dataframes.utils import base64
 
 SECRET_BYTES = 16
 VERSION = b"\x01"

cape_privacy/coordinator/auth/api_token_test.py → cape_dataframes/coordinator/auth/api_token_test.py

@@ -1,4 +1,4 @@
-from cape_privacy.coordinator.auth.api_token import create_api_token
+from cape_dataframes.coordinator.auth.api_token import create_api_token
 
 
 def test_api_token():

cape_privacy/coordinator/client.py → cape_dataframes/coordinator/client.py

@@ -5,10 +5,10 @@
 import requests
 import rfc3339
 
-from cape_privacy.coordinator.auth.api_token import APIToken
-from cape_privacy.policy import parse_policy
-from cape_privacy.policy.data import Policy
-from cape_privacy.utils import base64
+from cape_dataframes.coordinator.auth.api_token import APIToken
+from cape_dataframes.policy import parse_policy
+from cape_dataframes.policy.data import Policy
+from cape_dataframes.utils import base64
 
 
 class GraphQLError:

cape_privacy/coordinator/client_test.py → cape_dataframes/coordinator/client_test.py

@@ -3,11 +3,11 @@
 import pytest
 import responses
 
-from cape_privacy.audit import APPLY_POLICY_EVENT
-from cape_privacy.coordinator.auth.api_token import create_api_token
-from cape_privacy.coordinator.client import Client
-from cape_privacy.coordinator.client import GraphQLException
-from cape_privacy.policy import parse_policy
+from cape_dataframes.audit import APPLY_POLICY_EVENT
+from cape_dataframes.coordinator.auth.api_token import create_api_token
+from cape_dataframes.coordinator.client import Client
+from cape_dataframes.coordinator.client import GraphQLException
+from cape_dataframes.policy import parse_policy
 
 host = "http://localhost:8080"
 

cape_dataframes/pandas/__init__.py

@@ -0,0 +1,6 @@
+from cape_dataframes.pandas import dtypes
+from cape_dataframes.pandas import registry
+from cape_dataframes.pandas import transformations
+from cape_dataframes.pandas.transformer import transformer
+
+__all__ = ["dtypes", "transformations", "transformer", "registry"]

cape_privacy/pandas/registry.py → cape_dataframes/pandas/registry.py

@@ -1,15 +1,15 @@
 from typing import Callable
 from typing import Dict
 
-from cape_privacy.pandas.transformations import ColumnRedact
-from cape_privacy.pandas.transformations import DatePerturbation
-from cape_privacy.pandas.transformations import DateTruncation
-from cape_privacy.pandas.transformations import NumericPerturbation
-from cape_privacy.pandas.transformations import NumericRounding
-from cape_privacy.pandas.transformations import ReversibleTokenizer
-from cape_privacy.pandas.transformations import RowRedact
-from cape_privacy.pandas.transformations import Tokenizer
-from cape_privacy.pandas.transformations import TokenReverser
+from cape_dataframes.pandas.transformations import ColumnRedact
+from cape_dataframes.pandas.transformations import DatePerturbation
+from cape_dataframes.pandas.transformations import DateTruncation
+from cape_dataframes.pandas.transformations import NumericPerturbation
+from cape_dataframes.pandas.transformations import NumericRounding
+from cape_dataframes.pandas.transformations import ReversibleTokenizer
+from cape_dataframes.pandas.transformations import RowRedact
+from cape_dataframes.pandas.transformations import Tokenizer
+from cape_dataframes.pandas.transformations import TokenReverser
 
 TransformationCtor = Callable
 

cape_privacy/pandas/registry_test.py → cape_dataframes/pandas/registry_test.py

@@ -1,5 +1,5 @@
-from cape_privacy.pandas import registry
-from cape_privacy.pandas.transformations import test_utils
+from cape_dataframes.pandas import registry
+from cape_dataframes.pandas.transformations import test_utils
 
 
 def test_get():

cape_dataframes/pandas/transformations/__init__.py

@@ -0,0 +1,21 @@
+from cape_dataframes.pandas.transformations.column_redact import ColumnRedact
+from cape_dataframes.pandas.transformations.perturbation import DatePerturbation
+from cape_dataframes.pandas.transformations.perturbation import NumericPerturbation
+from cape_dataframes.pandas.transformations.rounding import DateTruncation
+from cape_dataframes.pandas.transformations.rounding import NumericRounding
+from cape_dataframes.pandas.transformations.row_redact import RowRedact
+from cape_dataframes.pandas.transformations.tokenizer import ReversibleTokenizer
+from cape_dataframes.pandas.transformations.tokenizer import Tokenizer
+from cape_dataframes.pandas.transformations.tokenizer import TokenReverser
+
+__all__ = [
+    "DateTruncation",
+    "DatePerturbation",
+    "NumericPerturbation",
+    "NumericRounding",
+    "ReversibleTokenizer",
+    "Tokenizer",
+    "TokenReverser",
+    "ColumnRedact",
+    "RowRedact",
+]

cape_privacy/pandas/transformations/column_redact_test.py → cape_dataframes/pandas/transformations/column_redact_test.py

@@ -2,7 +2,7 @@
 import pandas as pd
 import pandas.testing as pdt
 
-from cape_privacy.pandas.transformations import ColumnRedact
+from cape_dataframes.pandas.transformations import ColumnRedact
 
 
 def test_column_redact():

cape_privacy/pandas/transformations/perturbation.py → cape_dataframes/pandas/transformations/perturbation.py

@@ -6,9 +6,9 @@
 import numpy as np
 import pandas as pd
 
-from cape_privacy.pandas import dtypes
-from cape_privacy.pandas.transformations import base
-from cape_privacy.utils import typecheck
+from cape_dataframes.pandas import dtypes
+from cape_dataframes.pandas.transformations import base
+from cape_dataframes.utils import typecheck
 
 _FREQUENCY_TO_DELTA_FN = {
     "YEAR": lambda noise: pd.to_timedelta(noise * 365, unit="days"),

cape_privacy/pandas/transformations/perturbation_test.py → cape_dataframes/pandas/transformations/perturbation_test.py

@@ -4,9 +4,9 @@
 import pandas as pd
 import pandas.testing as pdt
 
-from cape_privacy.pandas import dtypes
-from cape_privacy.pandas.transformations import DatePerturbation
-from cape_privacy.pandas.transformations import NumericPerturbation
+from cape_dataframes.pandas import dtypes
+from cape_dataframes.pandas.transformations import DatePerturbation
+from cape_dataframes.pandas.transformations import NumericPerturbation
 
 
 def test_perturbation_float():

cape_privacy/pandas/transformations/rounding.py → cape_dataframes/pandas/transformations/rounding.py

@@ -2,9 +2,9 @@
 
 import pandas as pd
 
-from cape_privacy.pandas import dtypes
-from cape_privacy.pandas.transformations import base
-from cape_privacy.utils import typecheck
+from cape_dataframes.pandas import dtypes
+from cape_dataframes.pandas.transformations import base
+from cape_dataframes.utils import typecheck
 
 
 class NumericRounding(base.Transformation):

cape_privacy/pandas/transformations/rounding_test.py → cape_dataframes/pandas/transformations/rounding_test.py

@@ -4,9 +4,9 @@
 import pandas as pd
 import pandas.testing as pdt
 
-from cape_privacy.pandas import dtypes
-from cape_privacy.pandas.transformations import DateTruncation
-from cape_privacy.pandas.transformations import NumericRounding
+from cape_dataframes.pandas import dtypes
+from cape_dataframes.pandas.transformations import DateTruncation
+from cape_dataframes.pandas.transformations import NumericRounding
 
 
 def _make_apply_numeric_rounding(input, expected_output, ctype, dtype):

cape_privacy/pandas/transformations/row_redact_test.py → cape_dataframes/pandas/transformations/row_redact_test.py

@@ -2,7 +2,7 @@
 import pandas as pd
 import pandas.testing as pdt
 
-from cape_privacy.pandas.transformations import RowRedact
+from cape_dataframes.pandas.transformations import RowRedact
 
 
 def test_row_redact():

cape_privacy/pandas/transformations/tokenizer.py → cape_dataframes/pandas/transformations/tokenizer.py

@@ -4,9 +4,9 @@
 import pandas as pd
 from Crypto.Cipher import AES
 
-from cape_privacy.pandas import dtypes
-from cape_privacy.pandas.transformations import base
-from cape_privacy.utils import typecheck
+from cape_dataframes.pandas import dtypes
+from cape_dataframes.pandas.transformations import base
+from cape_dataframes.utils import typecheck
 
 
 class Tokenizer(base.Transformation):

cape_privacy/pandas/transformations/tokenizer_test.py → cape_dataframes/pandas/transformations/tokenizer_test.py

@@ -2,9 +2,9 @@
 import pandas.testing as pdt
 import pytest
 
-from cape_privacy.pandas.transformations import ReversibleTokenizer
-from cape_privacy.pandas.transformations import Tokenizer
-from cape_privacy.pandas.transformations import TokenReverser
+from cape_dataframes.pandas.transformations import ReversibleTokenizer
+from cape_dataframes.pandas.transformations import Tokenizer
+from cape_dataframes.pandas.transformations import TokenReverser
 
 
 def test_tokenizer():

cape_privacy/pandas/transformer.py → cape_dataframes/pandas/transformer.py

@@ -1,6 +1,6 @@
 import pandas as pd
 
-from cape_privacy.pandas.transformations import base as tfm
+from cape_dataframes.pandas.transformations import base as tfm
 
 
 def transformer(transformation: tfm.Transformation, df: pd.DataFrame, field_name: str):

cape_dataframes/policy/__init__.py

@@ -0,0 +1,13 @@
+from cape_dataframes.policy.data import Policy
+from cape_dataframes.policy.exceptions import NamedTransformNotFound
+from cape_dataframes.policy.exceptions import TransformNotFound
+from cape_dataframes.policy.policy import parse_policy
+from cape_dataframes.policy.policy import reverse
+
+__all__ = [
+    "parse_policy",
+    "Policy",
+    "NamedTransformNotFound",
+    "TransformNotFound",
+    "reverse",
+]

cape_privacy/policy/data.py → cape_dataframes/policy/data.py

@@ -18,8 +18,8 @@
 
 import yaml
 
-from cape_privacy.audit import AuditLogger
-from cape_privacy.utils import base64
+from cape_dataframes.audit import AuditLogger
+from cape_dataframes.utils import base64
 
 
 class Transform:

cape_privacy/policy/data_test.py → cape_dataframes/policy/data_test.py

@@ -1,9 +1,8 @@
 import yaml
 
-from cape_privacy.utils import base64
-
-from .data import Policy
-from .policy_test_fixtures import named_with_secret_y
+from cape_dataframes.policy.data import Policy
+from cape_dataframes.policy.policy_test_fixtures import named_with_secret_y
+from cape_dataframes.utils import base64
 
 y = """label: test_policy
 version: 1

cape_privacy/policy/policy.py → cape_dataframes/policy/policy.py

@@ -43,13 +43,13 @@
 import validators
 import yaml
 
-from cape_privacy import pandas as pandas_lib
-from cape_privacy import spark as spark_lib
-from cape_privacy.audit import APPLY_POLICY_EVENT
-from cape_privacy.audit import AuditLogger
-from cape_privacy.pandas import transformations
-from cape_privacy.policy import data
-from cape_privacy.policy import exceptions
+from cape_dataframes import pandas as pandas_lib
+from cape_dataframes import spark as spark_lib
+from cape_dataframes.audit import APPLY_POLICY_EVENT
+from cape_dataframes.audit import AuditLogger
+from cape_dataframes.pandas import transformations
+from cape_dataframes.policy import data
+from cape_dataframes.policy import exceptions
 
 
 def apply_policy(policy: data.Policy, df, inplace=False):
@@ -61,7 +61,7 @@ def apply_policy(policy: data.Policy, df, inplace=False):
 
     Args:
         policy: The `Policy` object that the transformed DataFrame will conform to, e.g.
-            as returned by `cape_privacy.parse_policy`.
+            as returned by `cape_dataframes.parse_policy`.
         df: The DataFrame object to transform according to `policies`. Must be of type
             pandas.DataFrame or pyspark.sql.DataFrame.
         inplace: Whether to mutate the `df` or produce a new one. This argument is only

cape_privacy/policy/policy_test.py → cape_dataframes/policy/policy_test.py

@@ -7,13 +7,13 @@
 import requests
 import yaml
 
-from cape_privacy import pandas as pandas_lib
-from cape_privacy import spark as spark_lib
-from cape_privacy.pandas.transformations import test_utils
-from cape_privacy.policy import data
-from cape_privacy.policy import exceptions
-from cape_privacy.policy import policy as policy_lib
-from cape_privacy.policy import policy_test_fixtures as fixtures
+from cape_dataframes import pandas as pandas_lib
+from cape_dataframes import spark as spark_lib
+from cape_dataframes.pandas.transformations import test_utils
+from cape_dataframes.policy import data
+from cape_dataframes.policy import exceptions
+from cape_dataframes.policy import policy as policy_lib
+from cape_dataframes.policy import policy_test_fixtures as fixtures
 
 
 def test_parse_policy(tmp_path):

cape_privacy/spark/__init__.py → cape_dataframes/spark/__init__.py

@@ -10,12 +10,12 @@ def is_available():
 else:
     from pyspark.sql import DataFrame
 
-    from cape_privacy.spark import dtypes
-    from cape_privacy.spark import registry
-    from cape_privacy.spark import transformations
-    from cape_privacy.spark.transformer import transformer
-    from cape_privacy.spark.utils import configure_session
-    from cape_privacy.spark.utils import make_session
+    from cape_dataframes.spark import dtypes
+    from cape_dataframes.spark import registry
+    from cape_dataframes.spark import transformations
+    from cape_dataframes.spark.transformer import transformer
+    from cape_dataframes.spark.utils import configure_session
+    from cape_dataframes.spark.utils import make_session
 
     def is_available():
         return True