diff --git a/.bumpversion.cfg b/.bumpversion.cfg index 51ba951..c50065c 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 0.0.0 +current_version = 1.0.0 commit = True tag = True diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 3209372..16ff8b6 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -2,7 +2,7 @@ Changelog ========= -0.0.0 (2021-10-08) +1.0.0 (2021-10-17) ------------------ -* First release on PyPI. +* Encrypted text field for Django and SQLAlchemy with AES-256-CTR \ No newline at end of file diff --git a/README.rst b/README.rst index 019eb2e..9502e62 100644 --- a/README.rst +++ b/README.rst @@ -15,7 +15,7 @@ Installation Usage ============ -You can use cryptbase with django ORM or witg SQLAlchemy. +You can use cryptbase with django ORM or with SQLAlchemy. To use with SQLAlchemy: diff --git a/docs/conf.py b/docs/conf.py index 86f42b1..eb7c6df 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -20,7 +20,7 @@ project = 'cryptbase' year = '2021' author = 'Alexandr Mansurov' copyright = '{0}, {1}'.format(year, author) -version = release = '0.0.0' +version = release = '1.0.0' pygments_style = 'trac' templates_path = ['.'] diff --git a/docs/usage.rst b/docs/usage.rst index 20dcd06..ecaeabc 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -2,6 +2,17 @@ Usage ===== -To use cryptbase in a project:: +You can use cryptbase with django ORM or with SQLAlchemy. - import cryptbase +To use with SQLAlchemy: + + from cryptbase import EncryptedText + sensitive = Column(EncryptedText(key=DB_KEY)) + +To use with django: + + from cryptbase import EncryptedTextField + sensitive = EncryptedTextField(key=DB_KEY) + +DB_KEY is 32 bytes encryption key as hex encoded string. Fields behave as TEXT fields, data are transparently encrypted +when storing into the database and decrypted on retrieval. diff --git a/setup.py b/setup.py index 123f511..6bdd7e7 100755 --- a/setup.py +++ b/setup.py @@ -23,7 +23,7 @@ def read(*names, **kwargs): setup( name='cryptbase', - version='0.0.0', + version='1.0.0', license='MIT', description='Protect yourself and your customers with database encryption.', long_description='%s\n%s' % ( diff --git a/src/cryptbase/__init__.py b/src/cryptbase/__init__.py index 229263d..e9eefde 100644 --- a/src/cryptbase/__init__.py +++ b/src/cryptbase/__init__.py @@ -1,4 +1,4 @@ -__version__ = '0.0.0' +__version__ = '1.0.0' import gc