Skip to main content

A CLI interface for dev.to

Project description

A CLI interface for dev.to

Please note before using that you should put your API key in the DEV_API_KEY environment variable. If you prefer, when starting the program will also look for a .env file in the working directory.

You can get this tool simply by doing a:

pip install dev-cli

Publishing

You can publish a Markdown file directly to dev.to using DEV-CLI. Your Markdown file must be identical to what you would input directly in the website’s interface.

Something else that you should take in account is the key. Indeed, when an article is created the API ID isn’t retrofitted to the Markdown file since this would get a little bit messy. Instead, you have several options to map your local files to your remote articles.

Namely you can use the cover_picture, the canonical_url or the title from the front matter. Please note that whatever you chose it must be set in the front matter, otherwise the program will fail. The default key is canonical_url, because it won’t appear in your source file unless you know what you’re doing.

Please note that you don’t have to use the same key every time. Suppose that you use the title but want to change it, you can do one sync with cover_picture instead of title as long as you don’t change both at the same time.

To publish using the canonical_url:

python -m dev_cli publish ~/dev/dev-blog/test.md

To publish using another key:

python -m dev_cli publish -k title ~/dev/dev-blog/test.md

In case of conflict the first found article will be updated.

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

dev-cli-0.2.0.tar.gz (8.2 kB view details)

Uploaded Source

File details

Details for the file dev-cli-0.2.0.tar.gz.

File metadata

  • Download URL: dev-cli-0.2.0.tar.gz
  • Upload date:
  • Size: 8.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/3.8

File hashes

Hashes for dev-cli-0.2.0.tar.gz
Algorithm Hash digest
SHA256 ab74aef8ed6b2e18e5f446508efd9d13b603aaa035c8d91f4e2efeacd9b83e5b
MD5 b340b3637b910fc9ce4da34e78a57c46
BLAKE2b-256 0ccf94034cc103b50e88675da532844912b846e2314da47531a7921ffa0141bd

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