Skip to content
This repository was archived by the owner on Feb 16, 2023. It is now read-only.

Files

Latest commit

e9d93e9 · Sep 1, 2020

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Sep 1, 2020
May 24, 2020

foobar-logo

Tests Coverage Downloads License Version OpenCollective

Foobar

Foobar is a Python library for dealing with word pluralization. Make sure that this block of text is no more than a paragraph. It should provide a clearly readible description of the intention of the repo and should be understandable by a total beginner. Don't go into a ton of technical detail here, just try to provide a nice high-level description of what this project is about. Here's a good example of how this section should be written.

  • 🔥 Feature one
  • 😄 Be sure to use emojis for features to help them stand out
  • 🚀 Another really cool feature
  • ⭐ Have up to 8 features, but no more

Installation

Use the package manager pip to install foobar.

pip install foobar

Usage

import foobar

foobar.pluralize('word') # returns 'words'
foobar.pluralize('goose') # returns 'geese'
foobar.singularize('phenomena') # returns 'phenomenon'

It might be good here to produce a few really simple examples of how this library can be used if indeed the library is multi-purpose. Be sure to use the Markdown headers to establish a correct heirarchy to the document.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Contributors

Please make sure to fill this section in with all former and current contributors to the project. Documentation on how to do this is located here.

License

Apache License 2.0