Rename to semiphemeral

app.py

@@ -1,3 +1,3 @@
 #!/usr/bin/env python3
-import ephemeral
-ephemeral.main()
+import semiphemeral
+semiphemeral.main()

ephemeral/__init__.py → semiphemeral/__init__.py

@@ -10,20 +10,20 @@
 
 
 @click.command()
-@click.option('--configure', is_flag=True, help='Start the web server to configure ephemeral')
+@click.option('--configure', is_flag=True, help='Start the web server to configure semiphemeral')
 @click.option('--fetch', is_flag=True, help='Download all tweets')
 @click.option('--delete', is_flag=True, help='Delete tweets that aren\'t automatically or manually excluded')
 @click.option('--debug', is_flag=True, help='Start web server in debug mode')
 def main(configure, fetch, delete, debug):
-    click.echo(click.style("ephemeral {}".format(version), fg='yellow'))
+    click.echo(click.style("semiphemeral {}".format(version), fg='yellow'))
 
     # Initialize stuff
-    os.makedirs(os.path.expanduser('~/.ephemeral'), exist_ok=True)
-    settings = Settings(os.path.expanduser('~/.ephemeral/settings.json'))
-    session = create_db(os.path.expanduser('~/.ephemeral/tweets.db'))
+    os.makedirs(os.path.expanduser('~/.semiphemeral'), exist_ok=True)
+    settings = Settings(os.path.expanduser('~/.semiphemeral/settings.json'))
+    session = create_db(os.path.expanduser('~/.semiphemeral/tweets.db'))
 
     if configure:
-        click.echo('Load this website in a browser to configure ephemeral, and press Ctrl-C when done')
+        click.echo('Load this website in a browser to configure semiphemeral, and press Ctrl-C when done')
         click.echo('http://127.0.0.1:8080')
         click.echo('')
         app = create_app(settings, session)

semiphemeral/templates/index.html

@@ -0,0 +1,24 @@
+{% extends "base.html" %}
+{% block title %}Semiphemeral{% endblock %}
+{% block header_text %}How Semiphemeral Works{% endblock %}
+{% block content %}
+
+<p>Semiphemeral will delete all of your old tweets except for specific ones you want to keep.
+
+<p>Go to <a href="{{ url_for('edit_settings') }}">settings</a> to configure your Twitter API credentials and username, as well as which tweets to automatically exclude from deletion.</p>
+
+<p>Go to <a href="{{ url_for('exceptions')}}">exceptions</a> to manually choose which tweets to exclude from deletion. This section lists your tweets that <em>would</em> automatically get deleted, and lets you manually exclude some of them.</p>
+
+<p>Before you can delete any tweets, or choose what tweets you want to manually exclude, you have to fetch all of your old tweets. To do this, run this:</p>
+
+<pre><code>semiphemeral --fetch</code></pre>
+
+<p>To actually delete old tweets, run this:</p>
+
+<pre><code>semiphemeral --delete</code></pre>
+
+<p>The Twitter API rate limits a lot, and when semiphemeral hits a rate limit, it will simply wait until it can continue using the API. For this reason, you should run the command once and wait for it to finish the first time &mdash; it may take a very long time if you have a lot of old tweets. Then set it to run automatically as a cron job to delete your old tweets going forward. (Ephemeral will always fetch tweets before deleting old ones.)</p>
+
+<p>Settings are stored in <code>~/.semiphemeral/settings.json</code>. All tweets (including exceptions, and deleted tweets) are stored in a sqlite database <code>~/.semiphemeral/tweets.db</code>.</p>
+
+{% endblock %}

setup.py

@@ -1,20 +1,20 @@
 import setuptools
-import ephemeral
+import semiphemeral
 
 with open("README.md", "r") as fh:
     long_description = fh.read()
 
 setuptools.setup(
-    name="ephemeral",
-    version=ephemeral.version,
+    name="semiphemeral",
+    version=semiphemeral.version,
     author="Micah Lee",
     author_email="micah@micahflee.com",
-    description="delete old tweets based on specific criteria",
     long_description=long_description,
+    description="Automatically delete your old tweets, except for the ones you want to keep",
     long_description_content_type="text/markdown",
     license="GPLv3+",
-    url="https://github.com/micahflee/ephemeral",
-    packages=['ephemeral'],
+    url="https://github.com/micahflee/semiphemeral",
+    packages=['semiphemeral'],
     classifiers=(
         "Development Status :: 2 - Pre-Alpha",
         "Environment :: Console",
@@ -23,7 +23,7 @@
     ),
     entry_points={
         'console_scripts': [
-            'ephemeral = ephemeral:main',
+            'semiphemeral = semiphemeral:main',
         ],
     },
     install_requires=[