Welcome to Pretty upper’s documentation!

Pretty upper

https://img.shields.io/pypi/v/pretty_upper.svg https://img.shields.io/travis/manikos/pretty_upper.svg Documentation Status

Removes accents from vowels when a Greek word/sentence is all capitals

Features

In Greek language (and in others too) there are some vowels that when are accented they have a special treatment during pronouncing the word.

The Greek language has 7 vowels: α, ε, η, ι, ο, υ and ω and all of them may be accented.

The problem comes when an accented vowel gets capitalized. The accent is not removed making the all-capital word look ugly with unnecessary accents.

In Greek grammar, when a word is all-capital, all accents from vowels should be removed. Thus, making it look prettier.

The all-capital word is a common scenario in web pages, such as the navigation menu, call to action (CTA) buttons, some headings etc.

For example compare the word ΜΕΝΟΎ with ΜΕΝΟΥ (both means menu but former has accent on Υ and latter has not). Which is prettier for the web?

This package tries to solve this issue and remove the accent from vowels when are capitalized.

Credits

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

Installation

Stable release

To install Pretty upper, run this command in your terminal:

$ pip install pretty_upper

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

You can either clone the public repository:

$ git clone git://github.com/manikos/pretty_upper

Or download the tarball:

$ curl  -OL https://github.com/manikos/pretty_upper/tarball/master

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

$ python setup.py install

Usage

To use Pretty upper in a project:

from pretty_upper.pretty_upper import pu

pu('hello')  # HELLO
pu('μενού')  # ΜΕΝΟΥ
pu('ά ί ο')  # Α Ι Ο

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/manikos/pretty_upper/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

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

  1. Fork the pretty_upper repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/pretty_upper.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 pretty_upper
$ cd pretty_upper/
$ 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 pretty_upper 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.7, 3.4, 3.5 and 3.6, and for PyPy. Check https://travis-ci.org/manikos/pretty_upper/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_pretty_upper

Deploying

A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in HISTORY.rst). Then run:

$ bumpversion patch # possible: major / minor / patch
$ git push
$ git push --tags

Travis will then deploy to PyPI if tests pass.

Credits

Development Lead

Contributors

None yet. Why not be the first?

History

0.1.0 (2018-03-10)

  • First release on PyPI.

Indices and tables