https://github.com/jaywink/shcli

Python client for Socialhome
https://github.com/jaywink/shcli

client federation socialhome

Last synced: 2 months ago
JSON representation

Python client for Socialhome

• Host: GitHub
• URL: https://github.com/jaywink/shcli
• Owner: jaywink
• License: mit
• Created: 2017-08-14T09:25:42.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-02-14T21:11:39.000Z (almost 5 years ago)
• Last Synced: 2024-10-07T21:41:24.257Z (3 months ago)
• Topics: client, federation, socialhome
• Language: Python
• Homepage: https://git.feneas.org/socialhome/shcli
• Size: 12.7 KB
• Stars: 5
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/jaywink/shcli.svg?branch=master)](https://travis-ci.org/jaywink/shcli) [![codecov.io](https://codecov.io/github/jaywink/shcli/coverage.svg?branch=master)](https://codecov.io/github/jaywink/shcli?branch=master) [![Dependency Status](https://gemnasium.com/badges/github.com/jaywink/shcli.svg)](https://gemnasium.com/github.com/jaywink/shcli)

[![snap](https://img.shields.io/badge/snap-shcli-orange.svg)](https://uappexplorer.com/snap/ubuntu/shcli) [![PyPI version](https://badge.fury.io/py/shcli.svg)](https://pypi.python.org/pypi/shcli) [![PyPI](https://img.shields.io/pypi/pyversions/shcli.svg?maxAge=2592000)](https://pypi.python.org/pypi/shcli) [![PyPI](https://img.shields.io/pypi/l/shcli.svg?maxAge=2592000)](https://pypi.python.org/pypi/shcli)

[![chat on freenode](https://img.shields.io/badge/chat-on%20freenode-brightgreen.svg)](http://webchat.freenode.net?channels=%23socialhome&uio=d4) [![Chat on Gitter](https://badges.gitter.im/Socialhome/Lobby.svg)](https://gitter.im/Socialhome/Lobby) [![chat on matrix](https://img.shields.io/badge/chat-on%20matrix-orange.svg)](https://riot.im/app/#/room/#socialhome:matrix.org)

# shcli

Python client for [Socialhome](https://socialhome.network).

## Introduction

Interact with your Socialhome account using the `shcli` client. This library will provide a CLI utility and a Python API. 

## Installation

### From PyPi

    pip install shcli

    

### As a Snap

    # For example on Ubuntu. See https://snapcraft.io/ for support on other OS's.

    sudo snap install shcli 

    

## Usage

Tool help:

    shcli --help

### Creating content

  

#### Tool

    shcli create   -t  -v 

    

For example:

    shcli create socialhome.network 123456789abcdefg -t 'Hello, World!' \

        -v public

#### Python API

    import shcli

    

    shcli.create(, , , )

    

For example:

    shcli.create(

        "socialhome.network", "123456789abcdefg", "Hello, World!", "public"

    )

  

Visibility parameter can be one of `public`, `limited`, `site` or `self`.

Returns the created `Content` object as JSON or another response with possible error messages.

## Development

### Install for development

    pip install -U -r dev-requirements.txt

    

### Running tests

    py.test

## License

[MIT](https://www.tldrlegal.com/l/mit)

## Author

Jason Robinson / https://jasonrobinson.me / `@jaywink:federator.dev`