Skip to content

Commit dd49f31

Browse files
committed
updated readme
1 parent c1aa2be commit dd49f31

File tree

2 files changed

+20
-28
lines changed

2 files changed

+20
-28
lines changed

README.rst

Lines changed: 18 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,19 @@
11
BANGLA
22
======
33

4-
|Build Status| |Version| |Python| |Size| |Codecov|
4+
|Version| |Python| |Size|
55

6-
Bangla is a package for Bangla language users with various functionalities including Bangla date and Bangla numeric conversation.
6+
Bangla is a Python package for converting Gregorian dates to the Bengali calendar, translating English numerals to Bangla numerals, and generating Bangla ordinals for dates.
7+
It computes the full Bengali calendar date, including year, month, day, weekday, season, and ordinal based on the revised Bengali calendar (https://en.wikipedia.org/wiki/Bengali_calendars) officially adopted in Bangladesh in 1987.
8+
(For Bengali communities in India, the calendar may differ slightly.)
79

8-
It can be used to get Bangla date that includes year, month, date, weekday and season of Bangla year.
9-
Bangla has used the rules from Wikipedia https://en.wikipedia.org/wiki/Bengali_calendars to convert
10-
Gregorian date to Bangla date. It is based on the revised version of the Bengali calendar which was officially adopted in Bangladesh in 1987.
11-
Among the Bengali community in India, the provided date may differ.
12-
13-
Moreover, this package has also a method to convert English numeric string to Bangla numeric string.
14-
15-
This software can be used on Linux/Unix, Mac OS and Windows systems.
10+
The package also allows converting English numeric strings (e.g., "123") into Bangla numerals (e.g., "১২৩").
11+
It is compatible with Linux, macOS, and Windows systems.
1612

1713
Features
1814
~~~~~~~~
1915

20-
- Get Bangla date that includes:
16+
- Convert Gregorian dates to Bengali calendar , including::
2117
- Bangla Date (১-৩১)
2218

2319
- Bangla Month ("বৈশাখ", "জ্যৈষ্ঠ", "আষাঢ়", "শ্রাবণ", "ভাদ্র", "আশ্বিন", "কার্তিক", "অগ্রহায়ণ", "পৌষ", "মাঘ", "ফাল্গুন", "চৈত্র")
@@ -37,7 +33,7 @@ Features
3733
Installation
3834
~~~~~~~~~~~~
3935

40-
We recommend install ``bangla`` through pip install using Python 3.
36+
We recommend install ``bangla`` through pip install.
4137

4238
.. code:: bash
4339
@@ -54,14 +50,14 @@ To get today's date in Bangla calendar:
5450
bangla_date = bangla.get_date()
5551
print(bangla_date)
5652
# Output: {'date': '৮', 'month': 'আষাঢ়', 'year': '১৪২৪', 'season': 'বর্ষা', 'weekday': 'বৃহস্পতিবার'}
57-
# Set ordinal=True to get the Bangla ordinal
53+
# Use bangla.get_date(ordinal = True) to include the Bangla ordinal
5854
5955
To convert any Gregorian date to Bangla date :
6056

6157
.. code:: python
6258
6359
import bangla
64-
bangla_date = bangla.get_date(20,6,2017) # date, month, year
60+
bangla_date = bangla.get_date(20, 6, 2017) # date, month, year
6561
print(bangla_date)
6662
# Output: {'date': '৬', 'month': 'আষাঢ়', 'year': '১৪২৪', 'season': 'বর্ষা', 'weekday': 'মঙ্গলবার'}
6763
@@ -76,33 +72,29 @@ To convert any English numeric string to Bangla numeric string :
7672
7773
Contributors
7874
~~~~~~~~~~~~
79-
Contributors: https://github.com/arsho/bangla/graphs/contributors
8075

81-
.. image:: https://contrib.rocks/image?repo=arsho/bangla
76+
|Contributors|
8277

83-
To contribute:
78+
Want to contribute?
8479

85-
Create Github Pull Request https://github.com/arsho/bangla/pulls
80+
Submit a Github Pull Request (must add/update unittests) https://github.com/arsho/bangla/pulls
8681

87-
For suggestions please reach me at https://arshovon.com/
82+
For suggestions or feedback, please contact https://arshovon.com/
8883

8984
Thanks
9085
~~~~~~
9186

9287
Influenced by বঙ্গাব্দ - jQuery Plugin
9388
https://github.com/nuhil/bangla-calendar
9489

95-
.. |Build Status| image:: https://travis-ci.org/arsho/bangla.svg?branch=master
96-
:target: https://travis-ci.org/arsho/bangla
97-
9890
.. |Version| image:: https://img.shields.io/pypi/v/bangla.svg?
9991
:target: http://badge.fury.io/py/bangla
10092

10193
.. |Python| image:: https://img.shields.io/pypi/pyversions/bangla.svg?
102-
:target: https://pypi.python.org/pypi/bangla/0.0.1
94+
:target: https://pypi.python.org/pypi/bangla/0.0.4
10395

10496
.. |Size| image:: https://img.shields.io/github/size/arsho/bangla/bangla/__init__.py.svg?
10597
:target: https://github.com/arsho/bangla/
106-
107-
.. |Codecov| image:: https://codecov.io/github/arsho/bangla/coverage.svg?branch=master
108-
:target: https://codecov.io/github/arsho/bangla
98+
99+
.. |Contributors| image:: https://contrib.rocks/image?repo=arsho/bangla
100+
:target: https://github.com/arsho/bangla/graphs/contributors

setup.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ def readme():
99

1010

1111
setup(name='bangla',
12-
version='0.0.3',
13-
description='Bangla is a package for Bangla language users with various functionalities including Bangla date and Bangla numeric conversation.',
12+
version='0.0.4',
13+
description='Bangla is a Python package for converting Gregorian dates to the Bengali calendar, translating English numerals to Bangla numerals, and generating Bangla ordinals for dates.',
1414
long_description=readme(),
1515
install_requires=[],
1616
classifiers=[

0 commit comments

Comments
 (0)