Welcome to synonym’s documentation!¶

Contents:

synonym: instant synonym answers via command line. 🖖¶

https://img.shields.io/pypi/v/synonym.svg https://img.shields.io/travis/gavinzbq/synonym.svg Documentation Status Updates

synonym is nice because it allows you stay in the console. If you love editing articles, essays and blogs using a console-based text editor, and from time to time find yourself searching synonyms for verbs and adjectives, then it is for you.

screenshot screenshot

Features¶

  • If the word was mispelled, synonym would give a guess.
  • Limiting to a specific property (n., v., adj., adv.) is possible.
  • synonym uses cache by default for faster access. Caching can be disabled by setting SYNONYM_DISABLE_CACHE environment variable. The cache is in ~/.cache/howdoi.
  • Powered by:
  • Beautiful terminal colors thanks to crayons.
  • Inspired by howdoi

Usage¶

usage: synonym [-h] [-p property] [the word of interest]

positional arguments:
  The Word of Interest

optional arguments:
  -h, --help            show this help message and exit
  -p, --property        the property of interest, choose from [n, v, adj, adv]
  -c, --color           enable colorized output

  -C, --clear-cache     clear the cache
  -v, --version         display the current version of synonym

Install¶

pip install synonym

Credits¶

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

Installation¶

Stable release¶

To install synonym, run this command in your terminal:

$ pip install synonym

This is the preferred method to install synonym, 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 synonym can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/gavinzbq/synonym

Or download the tarball:

$ curl  -OL https://github.com/gavinzbq/synonym/tarball/master

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

$ python setup.py install

Usage¶

To use synonym in a project:

import synonym

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://github.com/gavinzbq/synonym/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¶

synonym could always use more documentation, whether as part of the official synonym 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/gavinzbq/synonym/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 synonym for local development.

  1. Fork the synonym repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/synonym.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 synonym
$ cd synonym/
$ 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 synonym 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/gavinzbq/synonym/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ python -m unittest tests.test_synonym

History¶

0.1.0 (2017-06-22)¶

  • First release on PyPI.

0.1.1 (2017-06-24)¶

  • Second release on PyPI.

0.1.2 (2017-06-28)¶

  • Third release on PyPI.

0.1.3 (2017-06-29)¶

  • Fourth release on PyPI.

Indices and tables¶