Skip to main content

Generate a static HTML website from your twitter time line

Project description

http://img.shields.io/pypi/v/static_tl.svg

What is it?

It’ a tool that makes sure your TL won’t be gone for ever if for some reason twitter decides to no longer play nice.

In a way, it also makes it possible to:

  • edit your tweets

  • have them longer than 140 characters

Show me!

Here’s an example of static_tl in action:

http://dmerej.info/tweets

How to use it ?

  • Install Python3 and then install static_tl with pip

  • Create an app on http://apps.twitter.com

  • Edit ~/.config/static_tl.toml to have something like:

    [auth]
    api_key = "<Consumer Key>"
    api_secret = "<Consumer Secret>"
    
    token = "<Acces Token>"
    token_secret = "<Acess Token Secret>"
    
    [[users]]
    
    [users.user_one]
    with_replies = false
    
    [users.user_two]
    with_replies = true
  • Then run:

    static-tl get

This will generate some files with your recent tweets in a json folder.

For instance, if your run it on 2016 October 10, you’ll get two files:

  • json/<user>/2016-09.json (all the tweets from September)

  • json/<user>/2016-10.json (all the tweets from October so far)

  • Next time you’ll run static-tl get, we will look at the most recent status ID in the most recent .json file and only fetch new tweets. This means you can edit or even delete the tweets that are older than that :)

  • Then, when you are ready you can generate a completely static copy of your TL with:

    static-tl gen

(By static, we mean that it’s possible to upload those html files wherever you want so it’s extremely easy to publish your new TL on the web)

Tweaking the output

Customization can be done by simply editing the Jinja templates in static_tl/templates.

From the template you have access to all the fields returned by the official twitter API.

Also, any file not ending with .html in the templates folder will be copied directly to the html folder: useful for images, css files and the like.

Perform backup only

If you do not want to generate HTML files for a given user, use:

[[users]]

[users.<name>]
publish = false

Searching

Since version 0.4, static_tl gen also generates a tweets.sqlite file containing one table per user.

We use the FTS4 extension.

A search application is available in the sources : static_tl/search.py, using the flask framework.

This will only work if site_url is set, and if the flask server can be reached at <site_url>/search

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

static_tl-0.5.2.tar.gz (11.0 kB view details)

Uploaded Source

Built Distribution

static_tl-0.5.2-py3-none-any.whl (19.4 kB view details)

Uploaded Python 3

File details

Details for the file static_tl-0.5.2.tar.gz.

File metadata

  • Download URL: static_tl-0.5.2.tar.gz
  • Upload date:
  • Size: 11.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for static_tl-0.5.2.tar.gz
Algorithm Hash digest
SHA256 8f8827947523744fbd095cb6cfcdc573a017417b76472e93f6468e1464708f17
MD5 0e187ca9684a00915ae7b135768cd152
BLAKE2b-256 31f701257c011e84657998144b1e6613a8cb94a7d2211bd474776731b6a82701

See more details on using hashes here.

File details

Details for the file static_tl-0.5.2-py3-none-any.whl.

File metadata

File hashes

Hashes for static_tl-0.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b608176427d6659c0cfaf6566f672fdca212b81f6572b26cd7bef1d3eb881be1
MD5 1846cbdebb6dcdd4e14c3a21fde49ae4
BLAKE2b-256 232905b25e817af2cdc828710524dff74b7679199c98fc6f7411ecda7b4f31d0

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page