Skip to content
Permalink
Browse files

initial import

  • Loading branch information...
arianpasquali committed Nov 16, 2018
1 parent 65c12f0 commit 36b3f0967cbef4048261c33845eb036163c6f278
Showing with 12,299 additions and 0 deletions.
  1. +16 −0 AUTHORS.rst
  2. +114 −0 CONTRIBUTING.rst
  3. +647 −0 LICENSE
  4. +11 −0 MANIFEST.in
  5. +101 −0 README.rst
  6. +177 −0 docs/Makefile
  7. +1 −0 docs/authors.rst
  8. +275 −0 docs/conf.py
  9. +1 −0 docs/contributing.rst
  10. +1 −0 docs/history.rst
  11. +22 −0 docs/index.rst
  12. +51 −0 docs/installation.rst
  13. +242 −0 docs/make.bat
  14. +46 −0 docs/pyake.rst
  15. +1 −0 docs/readme.rst
  16. +48 −0 docs/usage.rst
  17. +7 −0 requirements.txt
  18. +29 −0 setup.cfg
  19. +57 −0 setup.py
  20. +26 −0 strategy.ini
  21. +3 −0 tests/__init__.py
  22. +1 −0 tests/doc1.txt
  23. +59 −0 tests/test_yake.py
  24. +39 −0 yake/Levenshtein.py
  25. +162 −0 yake/StopwordsList/stopwords_ar.txt
  26. +259 −0 yake/StopwordsList/stopwords_bg.txt
  27. +392 −0 yake/StopwordsList/stopwords_br.txt
  28. +256 −0 yake/StopwordsList/stopwords_cz.txt
  29. +64 −0 yake/StopwordsList/stopwords_da.txt
  30. +603 −0 yake/StopwordsList/stopwords_de.txt
  31. +75 −0 yake/StopwordsList/stopwords_el.txt
  32. +575 −0 yake/StopwordsList/stopwords_en.txt
  33. +351 −0 yake/StopwordsList/stopwords_es.txt
  34. +35 −0 yake/StopwordsList/stopwords_et.txt
  35. +332 −0 yake/StopwordsList/stopwords_fa.txt
  36. +747 −0 yake/StopwordsList/stopwords_fi.txt
  37. +463 −0 yake/StopwordsList/stopwords_fr.txt
  38. +163 −0 yake/StopwordsList/stopwords_hi.txt
  39. +179 −0 yake/StopwordsList/stopwords_hr.txt
  40. +737 −0 yake/StopwordsList/stopwords_hu.txt
  41. +45 −0 yake/StopwordsList/stopwords_hy.txt
  42. +359 −0 yake/StopwordsList/stopwords_id.txt
  43. +398 −0 yake/StopwordsList/stopwords_it.txt
  44. +44 −0 yake/StopwordsList/stopwords_ja.txt
  45. +65 −0 yake/StopwordsList/stopwords_lt.txt
  46. +167 −0 yake/StopwordsList/stopwords_lv.txt
  47. +259 −0 yake/StopwordsList/stopwords_nl.txt
  48. +119 −0 yake/StopwordsList/stopwords_no.txt
  49. +138 −0 yake/StopwordsList/stopwords_pl.txt
  50. +396 −0 yake/StopwordsList/stopwords_pt.txt
  51. +281 −0 yake/StopwordsList/stopwords_ro.txt
  52. +422 −0 yake/StopwordsList/stopwords_ru.txt
  53. +110 −0 yake/StopwordsList/stopwords_sk.txt
  54. +446 −0 yake/StopwordsList/stopwords_sl.txt
  55. +386 −0 yake/StopwordsList/stopwords_sv.txt
  56. +212 −0 yake/StopwordsList/stopwords_tr.txt
  57. +385 −0 yake/StopwordsList/stopwords_uk.txt
  58. +125 −0 yake/StopwordsList/stopwords_zh.txt
  59. +9 −0 yake/__init__.py
  60. +75 −0 yake/cli.py
  61. +417 −0 yake/datarepresentation.py
  62. +73 −0 yake/yake.py
@@ -0,0 +1,16 @@
=======
Credits
=======

Development
----------------

* Ricardo Campos <arrp@inesctec.pt>
* Vitor Mangaravite <arrp@inesctec.pt>
* Arian Pasquali <arrp@inesctec.pt>
* Alípio Jorge <arrp@inesctec.pt>

Contributors
------------

None yet. Why not be the first?
@@ -0,0 +1,114 @@
.. highlight:: shell

============
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/LIAAD/yake/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
~~~~~~~~~~~~~~~~~~~

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

1. Fork the `yake` repo on GitHub.
2. Clone your fork locally::

$ git clone git@github.com:your_name_here/yake.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 yake
$ cd yake/
$ 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 yake 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/LIAAD/yake/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_yake

0 comments on commit 36b3f09

Please sign in to comment.
You can’t perform that action at this time.