Skip to content

Commit 4986e63

Browse files
committed
update README.rst
1 parent 5a8ab87 commit 4986e63

File tree

1 file changed

+22
-26
lines changed

1 file changed

+22
-26
lines changed

README.rst

Lines changed: 22 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -7,54 +7,50 @@ Description
77
Installation Requirements
88
-----------------------------------
99

10-
* Python 3.0, 3.1, 3.2, 3.3, 3.4, 3.5
11-
* Django >= 1.7
10+
* Python >= 3.6
11+
1212
* To install the source, download it from https://github.com/Lh4cKg/simple-geolang-toolkit and do ``python setup.py install``.
1313

1414
A simple way to install ``geolang`` package::
1515

1616
$ pip install geolang
17-
$ pip install -r requirements.txt
1817

1918
To install the source ``geolang`` package::
2019

2120
$ git clone https://github.com/Lh4cKg/simple-geolang-toolkit "geolang"
2221
$ cd geolang
23-
$ sudo python setup.py install # if you do not have a default Python 3, then use the python3 install instead of python install
24-
$ pip install -r requirements.txt
22+
$ python3 setup.py build
23+
$ python3 setup.py install
2524

2625
Usage
2726
---------
2827

2928
To use ``geolang``, just import it in your project like so:
3029

31-
>>> import geolang as _ka
30+
>>> from geolang import encode_slugify, encode_text
3231

3332
You can convert the Latin words in Georgian
3433

35-
>>> latin_to_ka = _ka._2KA
36-
>>> _text_2ka = "i love you python and django"
37-
>>> latin_to_ka(_text_2ka)
38-
ი ლოვე ყოუ პყტჰონ ანდ დჯანგო
34+
>>> txt = "i love you python and django"
35+
>>> encode_text(txt)
36+
'ი ლოვე yოუ ფyტჰონ ანდ დჯანგო'
3937

4038
You can convert the Georgian words in Latin
4139

42-
>>> ka_to_latin = _ka._2LAT
43-
>>> _text_2lat = "მე მიყვარს ანი"
44-
>>> ka_to_latin(_text_2lat)
45-
me miyvars ani
46-
47-
>>> encode_slugify = _ka.encode_slugify
48-
>>> _try_encode_slugify = "ი ლოვე ყოუ პყტჰონ ანდ დჯანგო"
49-
>>> encode_slugify(_try_encode_slugify)
50-
b'i-love-you-python-and-django'
51-
>>> encode_slugify(_try_encode_slugify, _slugify=False)
52-
b'i love you python and django'
53-
>>> _try_encode_slugify_1 = "é\jcàé\jcàétéétéé\jéé\jcàété\jcàétécàété"
40+
>>> txt = "მე მიყვარს ანი"
41+
>>> encode_text(txt)
42+
'me miqvars ani'
43+
44+
>>> txt = "ი ლოვე ყოუ პყტჰონ ანდ დჯანგო"
45+
>>> encode_slugify(txt)
46+
'ი-ლოვე-ყოუ-პყტჰონ-ანდ-დჯანგო'
47+
>>> encode_slugify(txt)
48+
'i-love-qou-pqthon-and-django'
49+
>>> txt = "é\jcàé\jcàétéétéé\jéé\jcàété\jcàétécàété"
5450
>>> encode_slugify(_try_encode_slugify_1)
55-
b'ejcaejcaeteeteejeejcaetejcaetecaete'
51+
'éjcàéjcàétéétééjééjcàétéjcàétécàété'
5652

57-
See more examples_ in this project.
53+
See more tests_ in this project.
5854

5955
Source Code
6056
-----------------
@@ -69,10 +65,10 @@ There are plenty of ways to contribute to this project. If you think you’ve fo
6965
License
7066
------------------
7167

72-
``geolang`` is distributed under MIT license_.
68+
``geolang`` is distributed under MIT license_.
7369

7470

75-
.. _examples: https://github.com/Lh4cKg/simple-geolang-toolkit/blob/master/example.py
71+
.. _tests: https://github.com/Lh4cKg/simple-geolang-toolkit/blob/master/tests.py
7672
.. _github: https://github.com/Lh4cKg/simple-geolang-toolkit
7773
.. _issue: https://github.com/Lh4cKg/simple-geolang-toolkit/issues
7874
.. _license: https://github.com/Lh4cKg/simple-geolang-toolkit/blob/master/LICENSE.md

0 commit comments

Comments
 (0)