{ "info": { "author": "Sergej Alikov", "author_email": "sergej.alikov@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "License :: OSI Approved :: GNU Affero General Public License v3", "Programming Language :: Python :: 3" ], "description": "# ephemeral - Self-destructing messages\n\nEphemeral is a web application for sharing short messages. Messages can be opened\nonly once, giving an instant feedback to recipient on whether the message was\ncompromised(read by someone else) or not. This makes the app a reasonably secure,\nand convenient way to share secrets.\n\n## Highlights\n\n- Simple, easy-to-audit code\n- Messages are encrypted at rest\n\n\n## Installing\n\n```sh\npip install ephemeral\n```\n\nAfter installation you can use the `ephemeral.sh` command to start the\napplication (see below).\n\n\n## Running\n\nAlways put this application behind an HTTPS-terminating reverse proxy when exposing to\npublic networks!\n\nEphemeral uses Redis as the data store. Assuming Redis is running on `localhost`,\n\n```sh\nEPHEMERAL_REDIS_HOST=localhost EPHEMERAL_SECRET_KEY=hunter2 ephemeral.sh 0.0.0.0:8080\n```\n\nwill start the application listning on port 8080 on all network interfaces.\n\nPoint your browser at http://localhost:8080/add to add a message.\n\n\n## Developing\n\nPrerequisites:\n\n- Python 3\n- [pipenv](https://docs.pipenv.org/en/latest/#install-pipenv-today)\n\nInitialize a virtualenv with dev dependencies installed:\n\n```sh\nmake develop\n```\n\n\n### Project dependencies\n\nProject dependencies shoud always be specified in `setup.py` using the\n[compatible release](https://www.python.org/dev/peps/pep-0440/#compatible-release)\nnotation.\n\n\n### Updating dependencies in virtualenv\n\nRun the following after updating `setup.py`\n\n```sh\nmake update-deps\n```\n\n\n### Installing development dependencies\n\nReplace `` with the actual name, and `` with the MAJOR.MINOR\n(or MAJOR.MINOR.PATCH for versions below 1.0.0) version of the package.\n[Read more on compatible releases](https://www.python.org/dev/peps/pep-0440/#compatible-release).\n\n```sh\npipenv install --dev ~=\n```\n\n\n### Running unit-tests\n\n```sh\nmake test\n```\n\n\n### Starting a development instance of the application\n\nStart the application in development mode with debugging enabled:\n\n```sh\nmake dev-server\n```\n\n\n### Starting/stopping a development Docker stack\n\nThe development Docker (Compose) stack includes Redis container and an application\ncontainer built from source.\n\nPrerequisites:\n\n- Docker\n- docker-compose\n\n(Re)Build the application image, start a stack in background, and show running containers:\n\n```sh\nmake compose-build\n\nmake compose-up\n\nmake compose-ps\n```\n\nStop and destroy running stack:\n\n```sh\nmake compose-down\n```\n\n\n### Running E2E tests\n\nStart a stack and run Behave tests against it:\n\n```sh\nmake compose-up\n\nmake e2e-test\n```\n\n\n### Starting a release\n\nVariables:\n\n- `RELEASE_REMOTE` set to the name of the Git remote. Set to empty to disable pushes to\nremote. Default value: `origin`\n- `RELEASE_VERSION` override the release version, or leave empty to release the current\nsnapshot (`-SNAPSHOT` will be stripped off). Empty by default\n\n```sh\nmake release-start\n```\n\n\n### Finishing a release\n\nVariables:\n\n- `RELEASE_REMOTE` set to the name of the Git remote. Set to empty to disable pushes to\nremote. Default value: `origin`\n- `RELEASE_PUBLISH` set to `1` to enable publishing of the sdist tarball after the release`\n\n```sh\nmake release-finish\n```\n\n`release-finish` will leave the release Git tag checked out on completion.\n\n\n### Building and publishing the source distribution:\n\n```sh\nmake publish\n```", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/node13h/ephemeral", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "ephemeral", "package_url": "https://pypi.org/project/ephemeral/", "platform": "", "project_url": "https://pypi.org/project/ephemeral/", "project_urls": { "Homepage": "https://github.com/node13h/ephemeral" }, "release_url": "https://pypi.org/project/ephemeral/0.1.4/", "requires_dist": null, "requires_python": "", "summary": "Self-destructing messages", "version": "0.1.4" }, "last_serial": 5586025, "releases": { "0.1.1": [ { "comment_text": "", "digests": { "md5": "a089c60ce220c64e3df22a791e36ebe0", "sha256": "1501ebb0a3154b4f2c9c2c6f3bd1f4408fe43ce5f5a97de2e0f62e9d1b96b3e3" }, "downloads": -1, "filename": "ephemeral-0.1.1.tar.gz", "has_sig": false, "md5_digest": "a089c60ce220c64e3df22a791e36ebe0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 24052, "upload_time": "2019-07-15T21:16:06", "url": "https://files.pythonhosted.org/packages/d6/41/dd477e18a94e35e9bede31197845d65a67cf180ee98e85c041e80d08f40b/ephemeral-0.1.1.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "93bb4cee17ac0e78bdf593dac3ef220f", "sha256": "0ca720643a4389bc3b0f0c94e1aac7b12a835f7167c89ab1084bcd5f9628daf8" }, "downloads": -1, "filename": "ephemeral-0.1.3.tar.gz", "has_sig": false, "md5_digest": "93bb4cee17ac0e78bdf593dac3ef220f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17175, "upload_time": "2019-07-22T23:09:18", "url": "https://files.pythonhosted.org/packages/8c/34/615657cf83c27c8ef1e4972eff0f6d967f56be98b8cf2d16797f86121be3/ephemeral-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "3165a5e04ef888f1fda2a8a86f74caf6", "sha256": "9231e76160b100df82c0288abd523aaa9163b1f846da4f0f58d9868c36d5c71a" }, "downloads": -1, "filename": "ephemeral-0.1.4.tar.gz", "has_sig": false, "md5_digest": "3165a5e04ef888f1fda2a8a86f74caf6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17782, "upload_time": "2019-07-25T23:08:00", "url": "https://files.pythonhosted.org/packages/26/4e/53cc8bc0f63084accabdbc79ab66a2c68e353b5b6944f8e924288fadbf45/ephemeral-0.1.4.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "3165a5e04ef888f1fda2a8a86f74caf6", "sha256": "9231e76160b100df82c0288abd523aaa9163b1f846da4f0f58d9868c36d5c71a" }, "downloads": -1, "filename": "ephemeral-0.1.4.tar.gz", "has_sig": false, "md5_digest": "3165a5e04ef888f1fda2a8a86f74caf6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17782, "upload_time": "2019-07-25T23:08:00", "url": "https://files.pythonhosted.org/packages/26/4e/53cc8bc0f63084accabdbc79ab66a2c68e353b5b6944f8e924288fadbf45/ephemeral-0.1.4.tar.gz" } ] }