Merge branch 'release/1.0.0'

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.0.0
+current_version = 1.0.0
 commit = True
 tag = True
 

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

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:
 

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 = ['.']

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.

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' % (

src/cryptbase/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '0.0.0'
+__version__ = '1.0.0'
 
 import gc