Skip to main content

Create a tweet based on a #100DaysOfCode log message

Project description

LogTweet

Create a tweet based on a #100DaysOfCode log message.

Usage

The log url can be configured. The log has to have a format like my log, which you can find at https://log100days.lpld.io/log.md.

My log is based on the original #100DaysOfCode log repo. This is a markdown log. Have created a little Flask app that converts my log to an HTML site using the markdown2 package. But other Markdown converters should work similar.

Once you have an HTML document with h2 day headers and h3 sections for "Today's Progress" and "Link(s)", you can point the tool at that URL and generate a Tweet from it.

To actually enable the tweeting, you need to create a Twitter developer account and get an API key, API secret, Access Token and Access Token Secret.

The tweet will also contain the first link that you define in the "Link(s)" section under today's log. To save some space the link is shortened. By default, I use my own link shortener.

If you want to, you can also use the Bit.ly service. Their links might be a bit shorter and provide some engagement/tracking info. To use the Bitly service, you need to generate an API key through them and add it to the config (see below).

Options

If you want to create a tweet for a different day than today, you can do so with the --offset command line flag. The offset is defined in integer days relative to today. So to generate a tweet for yesterday use -o -1.

If you want to suppress the actual tweeting and only see the message in the console, use the --testmode command line flag.

Installation

I recommend pipx to install python scripts and other tools in isolated virtual environments. This keeps the you platform python clean and you don't have to worry about activating a particular virtual environment to use a tool/script.

pipx install logtweet

This way you will have a clean environment and the tool still available on the command line.

But if you want to, you should be able to install it with pip install logtweet.

Configuration

You need a configuration file for the script to work. The config.ini can either be in the current working directory or in ~/.config/logtweet/.

Because I can not figure out how to define a "post-install hook" that is run by pip I can not generate an example config at the defined location. You can find an example config on GitHub.

In that config file you define the URL where your log can be found and the API keys and access tokens that are needed for Twitter and Bit.ly.

Development

Install with

python -m pip install -e ".[develop]"

This installs the app dependencies as well as tools to develop and distribute the package.

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

logtweet-0.1.3.tar.gz (7.8 kB view details)

Uploaded Source

Built Distribution

logtweet-0.1.3-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

Details for the file logtweet-0.1.3.tar.gz.

File metadata

  • Download URL: logtweet-0.1.3.tar.gz
  • Upload date:
  • Size: 7.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.8.0

File hashes

Hashes for logtweet-0.1.3.tar.gz
Algorithm Hash digest
SHA256 1c891ea51e942ad6492dde4227e3d059978a2637f4adabccc4b762b75bf1f369
MD5 9d76ed74f8d933a0c99f7d73e1bdb677
BLAKE2b-256 847d161340260a4e3448625e909fa1ecb9892336f579d6e247dac3c8bc271835

See more details on using hashes here.

File details

Details for the file logtweet-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: logtweet-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 8.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.8.0

File hashes

Hashes for logtweet-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 8fa9835bf97a2909d0785c7bbfe504a0364dfcec7e120d9a92869d982daae4b3
MD5 47a29bdd037627a7841fe24d3a5ddc9e
BLAKE2b-256 9146decab9f716b8c60fba7f970592e6bfa66c91524c54372ff7926e8a7b00d7

See more details on using hashes here.

Supported by

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