Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Update files for preparation upload to pypi

  • Loading branch information...
commit f14237dc36e9f63523b68d61ac277932e550bf45 1 parent 22d7c1e
@thenoviceoof authored
View
8 .gitignore
@@ -1,6 +1,2 @@
-*
-!.gitignore
-!EncryptedFile.py
-!__init__.py
-!README
-!LICENSE
+*~
+*.pyc
View
1  CHANGES.txt
@@ -0,0 +1 @@
+v1.0.0, 2013/9/8 -- MVP complete
View
4 LICENSE.TXT
@@ -0,0 +1,4 @@
+"THE BEER-WARE LICENSE" (Revision 42):
+<thenoviceoof> wrote this file. As long as you retain this notice you
+can do whatever you want with this stuff. If we meet some day, and you think
+this stuff is worth it, you can buy me a beer in return
View
1  MANIFEST.in
@@ -0,0 +1 @@
+include *.txt
View
2  README.md
@@ -60,6 +60,6 @@ Todo
License
--------------------------------------------------------------------------------
"THE BEER-WARE LICENSE" (Revision 42):
-<thenoviceoof@gmail> wrote this file. As long as you retain this notice you
+<thenoviceoof> wrote this file. As long as you retain this notice you
can do whatever you want with this stuff. If we meet some day, and you think
this stuff is worth it, you can buy me a beer in return
View
80 README.rst
@@ -0,0 +1,80 @@
+=============
+encryptedfile
+=============
+
+Write OpenPGP compatible-encrypted files like it ain't no thang.
+Symmetric ciphers only.
+
+-----
+Usage
+-----
+
+Use it by itself:
+
+::
+
+ from encryptedfile.EncryptedFile import EncryptedFile
+ f = EncryptedFile("hello.gpg", passphrase=getpass.getpass(),
+ encryption_algo=EncryptedFile.ALGO_AES256)
+ f.write("super secret message")
+ f.close()
+
+Or with something passed through it:
+
+::
+
+ from encryptedfile.EncryptedFile import EncryptedFile
+ import PIL
+ img = ... # obtain image somehow
+ f = EncryptedFile("pic.png.gpg", passphrase=getpass.getpass(),
+ encryption_algo=EncryptedFile.ALGO_BLOWFISH)
+ img.save(f, "png")
+
+Or use it in a `PEP-343 <http://www.python.org/dev/peps/pep-0343/>`_
+block:
+
+::
+
+ from encryptedfile import EncryptedFile
+ with EncryptedFile("txt.gpg", passphrase=getpass.getpass()) as f:
+ ... use f ...
+
+-------
+Decrypt
+-------
+
+Let's say we're using gpg:
+
+::
+
+ gpg filename
+
+Supply the right passphrase, and tada!
+
+---
+FAQ
+---
+
+- Do you support reading?
+
+No, reading would mean supporting the bajillion ways that OpenPGP files
+have been created throughout history. That would be a pain. I may at
+some point in time support reading well enough to be able to read
+whatever written by this module.
+
+----
+Todo
+----
+
+- change ``import encryptedfile.EncryptedFile.EncryptedFile`` to
+ ``import encryptedfile.EncryptedFile``, probably when we bump the
+ major version number
+
+-------
+License
+-------
+
+"THE BEER-WARE LICENSE" (Revision 42): wrote this file. As long as you
+retain this notice you can do whatever you want with this stuff. If we
+meet some day, and you think this stuff is worth it, you can buy me a
+beer in return
View
0  EncryptedFile.py → encryptedfile/EncryptedFile.py
File renamed without changes
View
0  __init__.py → encryptedfile/__init__.py
File renamed without changes
View
16 setup.py
@@ -0,0 +1,16 @@
+from distutils.core import setup
+
+setup(
+ name='encryptedfile',
+ version='1.0.0',
+ author='thenoviceoof',
+ author_email='thenoviceoof@gmail.com',
+ packages=['encryptedfile'],
+ url='https://github.com/thenoviceoof/encryptedfile',
+ license='LICENSE.txt',
+ description='Easily encrypted OpenPGP compatible files with python',
+ long_description=open('README.rst').read(),
+ install_requires=[
+ 'pycrypto >= 2.6'
+ ],
+)
Please sign in to comment.
Something went wrong with that request. Please try again.