Contents¶
Usage¶
To use monogatari in a project:
from monogatari import JMFDCounter
counter = JMFDCounter()
list_of_words = ['私', 'コーヒー', '好き', '友達']
counter.count(list_of_words)
counter.top(100) # List top N categories, ordered by number of words
counter.top_normalized(100) # List top N categories, ordered by number of words normalized by the total number of words
In this example, we are using J-MFD dictionary (https://github.com/soramame0518/j-mfd) as the base for word counting.
However, we can load a custom dictionary using the class `DictCounter`:
from monogatari import DictCounter
counter = DictCounter('/path/to/the/dictionary.dic')
list_of_words = ['私', 'コーヒー', '好き', '友達']
counter.count(list_of_words)
counter.top(100) # List top N categories, ordered by number of words
counter.top_normalized(100) # List top N categories, ordered by number of words normalized by the total number of words
The dictionary file must have the following structure:
%
Category_key_1 Category_value_1
Category_key_2 Category_value_2
Category_key_3 Category_value_3
Category_key_4 Category_value_4
%
Word_key_1 Category_key_1 Category_key_2
Word_key_2 Category_key_1
Word_key_3 Category_key_2
Word_key_4 Category_key_1 Category_key_3
Word_key_5 Category_key_1 Category_key_2 Category_key_4
Word_key_6 Category_key_4
Available dictionaries¶
MFD (from https://www.moralfoundations.org/):
from monogatari import MFDCounter counter = MFDCounter()
JMFD (from https://github.com/soramame0518/j-mfd):
from monogatari import JMFDCounter counter = JMFDCounter()
Contributing¶
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
Bug reports¶
When 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.
Documentation improvements¶
monogatari could always use more documentation, whether as part of the official monogatari docs, in docstrings, or even on the web in blog posts, articles, and such.
Feature requests and feedback¶
The best way to send feedback is to file an issue at https://github.com/brunotoshio/monogatari/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 code contributions are welcome :)
Development¶
To set up monogatari for local development:
Fork monogatari (look for the “Fork” button).
Clone your fork locally:
git clone git@github.com:your_name_here/monogatari.git
Create a branch for local development:
git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
When you’re done making changes, run all the checks, doc builder and spell checker with tox one command:
toxCommit 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
Submit a pull request through the GitHub website.
Pull Request Guidelines¶
If you need some code review or feedback while you’re developing the code just make the pull request.
For merging, you should:
- Include passing tests (run
tox) [1]. - Update documentation when there’s new API, functionality etc.
- Add a note to
CHANGELOG.rstabout the changes. - Add yourself to
AUTHORS.rst.
| [1] | If you don’t have all the necessary python versions available locally you can rely on Travis - it will run the tests for each change you add in the pull request. It will be slower though … |
Tips¶
To run a subset of tests:
tox -e envname -- pytest -k test_myfeature
To run all the test environments in parallel (you need to pip install detox):
detox
Authors¶
- Bruno Toshio Sugano