Skip to content
This repository has been archived by the owner on Mar 21, 2022. It is now read-only.
/ podops.legacy Public archive

PodOps is a podcast infrastructure platform, providing an API, CLI and backend services.

License

Notifications You must be signed in to change notification settings

podops/podops.legacy

Repository files navigation

PodOps - Programmable Podcasts

Join the chat at https://gitter.im/podops/help

Podops is a podcast infrastructure platform that provides functionallity to automate your podcast creation workflow. It allows you to create the podcast feed and delivers media assets like mp3s or images to podcast clients.

The platform follows an API-first approach and is very light on user-facing frontends. Almost all interactions with Podops happens either using po the command line interface or by directly calling the Rest API.

If you need support or have ideas for improving Podops, please join the Podops Gitter community or visit the GitHub Issues section of this repo. Please visit the Podops document repository for installation instructions and documentation.

If you find this project interesting, please consider starring it here on GitHub!

Getting started

To use Podops, you need an API access key for https://api.podops.dev. To get your key, you have to install po, the command line tool first. After installing it, you can register your account and request your API key.

Download the binary

Download the latest binary for your system:

Unpack the archive and place the po binary in a directory that is on your $PATH. Verify that the command line tool is accessible:

$ po help

Register and get the API key

Step 1: Request an access code

$ po login <your_email_address>

Podops will send you an email with a temporary access code. Use the access code to exchange it for your API access key. The access code is valid for 10 min and can only be used once. In case you missed this time-window, start over with the login command.

Note: If you login for the first time, Podops will send you an email to verify your Email-Address first. Confirm by following the link in the Email. The link is valid for 10 min. After confirming your email, you will receive the email with the confirmation code.

Step 2: Request the API key

$ po login <your_email_address> <access_code>

This will retrieve your current API key and place it in its default location $HOME/.po/config. You can verify that everything is setup correctly by issuing a command that requires authentication e.g.

$ po shows

Examples

Examples on how to use the Command Line Interface or Go Client SDK to create and publish your podcast are here.

Documentation

The documentation repository is here

Development

A description how to build the codebase and how to test locally is here.

Open-source but not open-contribution?

I am grateful for community involvement, bug reports, & feature requests but I do not expect code contributions at this point in time as there is not really a substantial user base or community in general. In case someone wants to contribute, I will gladly review pull requests.

There is another way to help the project: many of the most valuable contributions are in the forms of testing, feedback, and documentation. This helps to harden the software and streamlines its usage for other users.

Should you wish to contribute, please review the contribution guidelines first.

Note: While all the Podops code is here on GitHub, there is no step-by-step guide how install it on your own infrastructure at the moment. This will come later. If you want to deploy Podops on your own infrastructure TODAY, join the community on Gitter and send me a DM at @mickuehl and we will sort it out.

About

PodOps is a podcast infrastructure platform, providing an API, CLI and backend services.

Topics

Resources

License

Stars

Watchers

Forks

Languages