Turtle Documentation

Release 1.0.0

Vu Anh

February 26, 2017

 Contents

1 Turtle - Vietnamese NLP Toolkit 3

1.1 Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

2 Installation 5
2.1 Stable release . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.2 From sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

3 Usage 7

4 Contributing 9
4.1 Types of Contributions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
4.2 Get Started! . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
4.3 Pull Request Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
4.4 Tips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

5 Indices and tables 13

i
ii
 Turtle Documentation, Release 1.0.0

Contents:

Contents 1
Turtle Documentation, Release 1.0.0

2 Contents
 CHAPTER 1

Turtle - Vietnamese NLP Toolkit

turtle.jpg

• Free software: GNU General Public License v3

• Documentation: https://turtle.readthedocs.io.
An attempt to research about Vietnamese Natural Language Processing

Features

• Open Corpus for create, maintain corpuses

• Open Toolkit

3
Turtle Documentation, Release 1.0.0

4 Chapter 1. Turtle - Vietnamese NLP Toolkit

 CHAPTER 2

Installation

Stable release

To install Turtle, run this command in your terminal:

$ pip install turtle

This is the preferred method to install Turtle, 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 Turtle can be downloaded from the Github repo.
You can either clone the public repository:
$ git clone git://github.com/rain1024/turtle

Or download the tarball:

$ curl -OL https://github.com/rain1024/turtle/tarball/master

Once you have a copy of the source, you can install it with:
$ python setup.py install

5
Turtle Documentation, Release 1.0.0

6 Chapter 2. Installation
 CHAPTER 3

Usage

To use Turtle in a project:

import turtle

7
Turtle Documentation, Release 1.0.0

8 Chapter 3. Usage
 CHAPTER 4

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/rain1024/turtle/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

Turtle could always use more documentation, whether as part of the official Turtle docs, in docstrings, or even on the
web in blog posts, articles, and such.

9
Turtle Documentation, Release 1.0.0

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/rain1024/turtle/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 turtle for local development.

1. Fork the turtle repo on GitHub.
2. Clone your fork locally:
$ git clone [email protected]:your_name_here/turtle.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 turtle
$ cd turtle/
$ 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 turtle 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.

10 Chapter 4. Contributing
 Turtle Documentation, Release 1.0.0

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/rain1024/turtle/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_turtle

4.4. Tips 11
Turtle Documentation, Release 1.0.0

12 Chapter 4. Contributing
 CHAPTER 5

Indices and tables

• genindex
• modindex
• search

13