Giter VIP home page Giter VIP logo

podops.legacy's Introduction

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.

podops.legacy's People

Contributors

gitter-badger avatar mickume avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Forkers

gitter-badger

podops.legacy's Issues

Ensure that episode 'name' is unique

Ensure that episode 'name' is unique within the context of a show. Otherwise UI gets confusing if there are multiple episodes with the same 'name' but different GUIDs

Fix the GitHub workflow to build the CLI

Building the CLI for different platforms creates an archive that returns a 'wrong' binary when unpacking. "Wrong" meaning the name of the binary is different from what is described in the docs.

Better logging of failed requests in the CDN

Currently the CDN service reports a request for a non existing resource as an error.

This should be just logged, in a separate logger or with tags to search/filter later. We also need to know WHO requested the resource.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.