Welcome to minds-cli’s documentation!

Contents:

minds-cli

https://img.shields.io/pypi/v/minds-cli.svg https://img.shields.io/travis/granitosaurus/minds-cli.svg Documentation Status Updates

cli interface for minds-api.

Features

  • Support these commands:

    Commands:
  downvote       downvote content
  upvote         upvote content
  delete         delete content
  newsfeed       display newsfeed in the terminal
      boost       boost section
      channel     specific channel
      subscribed  subscribed section
      top         top section
  notifications  display notifications in the terminal
      all            show all notification categories
      comments       show only comment notifications
      groups         show only group notifications
      subscriptions  show only subscription notifications
      tags           show only tag notifications
      votes          show only vote notifications
  post           Create post/comment or display one
      blog      post a blog under current user's blogfeed
      comment   post a comment under a piece of content
      newsfeed  post a post under current user's newsfeed
  profile        Manage local user profiles
      list  list local profiles
      save  save profile locally from provided...
  show           Create post/comment or display one
      comments  show comments
      post      show single post

  • Supports user profiles for easy sharing through multiple profiles.

  • Prints formatted posts, newsfeeds and comments in terminal:

    $ minds newsfeed channel tinarg
Working from Chiang Mai, Thailand this month!
Got a condo with this view, pool and a gym for 400€ per month.
Pretty lovely place so far!

#chiangmai #thailand #digitalnomad #workspaceview
https://www.minds.com/fs/v1/thumbnail/825548664578514944
---tinarg---4/0----------------------https://minds.com/newsfeed/825549491984670720-----------------------C:0---R:0---

  • Posting supports input via editor, file or stdin with markdown conversion for blogs (yes you can write blogs in markdown!)

See docs for more: https://minds-cli.readthedocs.io.

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

If you wish to support this project you can open up an issue or send me a tip:

  • Bitcoin: 18oJWwdy1XExN69kggj2JdYtqohMPx9QF8
  • Bitcoin Cash: 18oJWwdy1XExN69kggj2JdYtqohMPx9QF8
  • Doge: DEmJSgawKvtS9CGQUC7QdNETa2UuYBrenS
  • Ethereum: 0xe8b452F9E3FDa8CEB32b2C231f73cC5cFa67735B
  • Monero: 43PAxkfekEYQki3HTQkgt9eH7KK5ZRBd447HkumTGmo8cacA9vP25MwWbwaVe4vUMveKAzAiA4j8xgUi29TpKXpm3yjjWof

Installation

Stable release

To install minds-cli, run this command in your terminal:

$ pip install minds-cli

This is the preferred method to install minds-cli, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for minds-cli can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://gitlab.com/granitosaurus/minds-cli

Or download the tarball:

$ curl  -OL https://gitlab.com/granitosaurus/minds-cli/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage

Authenticating

minds-cli supports user authentication and profile management:

Options:
  -u TEXT             username of minds channel
  -p TEXT             password of minds channel
  --proxy TEXT        proxy for minds requests
  -c, --profile TEXT  load local profile config

Profiles are saved by default in $XDG_CONFIG/minds directory when authentication is successful.

For example, your first post would be:

minds -u "username" -p "password" post newsfeed "hello world, posting from api!"

Afterwards you can load your config through -c command:

minds -c username post newsfeed “hello world, posting from api AGAIN!”

Posting

minds-cli post commands can take message from 3 sources:

  1. command line argument, e.g. minds post newsfeed "my message"
  2. through local editor (will use $EDITOR env variable). This is default if cli argument is not supplied
  3. stdin - allows multiline stdin input:
  4. file - reads contents from file

Reading

minds-cli supports basic formatted terminal output for reading posts, comments and notifications;

e.g.:

$ minds newsfeed channel tinarg
Working from Chiang Mai, Thailand this month!
Got a condo with this view, pool and a gym for 400€ per month.
Pretty lovely place so far!

#chiangmai #thailand #digitalnomad #workspaceview
https://www.minds.com/fs/v1/thumbnail/825548664578514944
---tinarg---4/0----------------------https://minds.com/newsfeed/825549491984670720-----------------------C:0---R:0---

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://gitlab.com/granitosaurus/minds-cli/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

minds-cli could always use more documentation, whether as part of the official minds-cli docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/granitosaurus/minds-cli/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up minds-cli for local development.

  1. Fork the minds-cli repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/mindscli.git

  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

    $ mkvirtualenv mindscli
$ cd mindscli/
$ python setup.py develop

  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

    $ flake8 mindscli tests
$ python setup.py test or py.test
$ tox

    To get flake8 and tox, just pip install them into your virtualenv.

  6. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check https://travis-ci.org/granitosaurus/mindscli/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ py.test tests.test_mindscli

Credits

Development Lead

Contributors

None yet. Why not be the first?

History

0.1.0 (2018-04-18)

  • First release on PyPI.

Indices and tables