https://github.com/roperzh/medium-sdk-elixir

Elixir SDK for the Medium.com API. :globe_with_meridians:
https://github.com/roperzh/medium-sdk-elixir

elixir medium medium-api medium-sdk

Last synced: 22 days ago
JSON representation

Elixir SDK for the Medium.com API. :globe_with_meridians:

• Host: GitHub
• URL: https://github.com/roperzh/medium-sdk-elixir
• Owner: roperzh
• License: mit
• Created: 2016-11-22T17:28:35.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2018-09-04T03:22:27.000Z (about 6 years ago)
• Last Synced: 2024-09-27T08:47:48.821Z (about 1 month ago)
• Topics: elixir, medium, medium-api, medium-sdk
• Language: Elixir
• Homepage:
• Size: 41 KB
• Stars: 20
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/roperzh/medium-sdk-elixir.svg?branch=master)](https://travis-ci.org/roperzh/medium-sdk-elixir)

[![Coverage Status](https://coveralls.io/repos/github/roperzh/medium-sdk-elixir/badge.svg?branch=master)](https://coveralls.io/github/roperzh/medium-sdk-elixir?branch=master)

[![Hex.pm](https://img.shields.io/hexpm/v/medium.svg)](https://hex.pm/packages/medium)

# Medium SDK for Elixir

An Elixir SDK for the Medium.com [API](https://github.com/Medium/medium-api-docs).

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed as:

  1. Add `medium` to your list of dependencies in `mix.exs`:

    ```elixir

    def deps do

      [{:medium, "~> 0.2"}]

    end

    ```

  2. Ensure `medium` is started before your application:

    ```elixir

    def application do

      [applications: [:medium]]

    end

    ```

## Usage

Since all Medium requests must be made with an integration token, you need

to create a new client associated with that token in order to perform requests:

```elixir

client = Medium.client("my-access-token")

```

With our client at hand, we can start making requests to the API! :boom:

```elixir

# We can perform all GET requests described on the API:

user = Medium.me(client)

user_publications = Medium.publications(client, user.id)

# And we can also publish:

post = %{

  title: "Liverpool FC",

  content_format: "html",

  content: "
Liverpool FC
You’ll never walk alone.
",

  canonical_url: "http://jamietalbot.com/posts/liverpool-fc",

  tags: ["football", "sport", "Liverpool"],

  publish_status: "public"

}


response = Medium.publish(client, user.id, post)

```

Don't forget to check the Medium [API](https://github.com/Medium/medium-api-docs)

or the [documentation](https://hexdocs.pm/medium/api-reference.html)

to see all available methods.

## Roadmap

- [ ] Improve the documentation

- [ ] Improve the test suite

- [ ] Remove the Tesla dependency

## Licence

All the code contained in this repository, unless explicitly stated, is licensed under an MIT license.

A copy of the license can be found in the [LICENSE](LICENSE) file.