├── .coveragerc ├── .editorconfig ├── .github └── workflows │ └── python-package.yml ├── .gitignore ├── CHANGELOG.md ├── CONTRIBUTING.md ├── LICENSE ├── Makefile ├── Pipfile ├── README.md ├── codecov.yml ├── django_nepali ├── __init__.py └── templatetags │ ├── __init__.py │ ├── nepalidatetime.py │ └── nepalinumber.py ├── django_nepali_example ├── README.md ├── settings.py └── tests │ ├── __init__.py │ └── template_tags │ ├── __init__.py │ ├── fixtures │ ├── nepalidatetime.py │ └── nepalinumber.py │ ├── test_nepalidatetime.py │ └── test_nepalinumber.py ├── manage.py ├── pyproject.toml ├── pytest.ini └── setup.cfg /.coveragerc: -------------------------------------------------------------------------------- 1 | [run] 2 | omit = django_nepali/tests/* 3 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | # EditorConfig is awesome: http://EditorConfig.org 2 | 3 | # top-most EditorConfig file 4 | root = true 5 | 6 | # Unix-style newlines with a newline ending every file 7 | [*] 8 | end_of_line = lf 9 | insert_final_newline = true 10 | 11 | # Matches multiple files with brace expansion notation 12 | # Set default charset 13 | [*.{py,rst,md}] 14 | charset = utf-8 15 | 16 | # 4 space indentation 17 | [*.py] 18 | indent_style = space 19 | indent_size = 4 20 | 21 | # Max line length of 120 characters 22 | [*.py] 23 | max_line_length = 120 24 | 25 | # Use double quotes instead of single quotes 26 | [*.py] 27 | quote_style = double 28 | -------------------------------------------------------------------------------- /.github/workflows/python-package.yml: -------------------------------------------------------------------------------- 1 | # This workflow will install Python dependencies, run tests and lint with a variety of Python versions 2 | # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions 3 | 4 | name: Python Package 5 | 6 | on: 7 | push: 8 | branches: ["main"] 9 | pull_request: 10 | 11 | jobs: 12 | build: 13 | runs-on: ubuntu-latest 14 | strategy: 15 | fail-fast: false 16 | matrix: 17 | python-version: ["3.8", "3.9", "3.10"] 18 | 19 | steps: 20 | - uses: actions/checkout@v3 21 | 22 | - name: Set up Python ${{ matrix.python-version }} 23 | uses: actions/setup-python@v3 24 | with: 25 | python-version: ${{ matrix.python-version }} 26 | 27 | - name: Install Pipenv 28 | run: | 29 | python -m pip install --upgrade pip 30 | python -m pip install pipenv 31 | 32 | - name: Install dependencies 33 | run: | 34 | make install-dev 35 | 36 | - name: Lint with flake8 37 | run: | 38 | # stop the build if there are Python syntax errors or undefined names 39 | pipenv run flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics 40 | # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide 41 | pipenv run flake8 . --count --exit-zero --max-complexity=10 --ignore=E203,W503 --max-line-length=127 --statistics 42 | # For the reason behind ignoring E203 and W503, visit https://blackq.readthedocs.io/en/stable/faq.html#why-are-flake8-s-e203-and-w503-violated 43 | 44 | - name: Run test and coverage 45 | run: | 46 | make coverage 47 | 48 | - name: Generate coverage report 49 | run: | 50 | pipenv run coverage xml 51 | 52 | - name: Send coverage to CodeCov 53 | uses: codecov/codecov-action@v3 54 | with: 55 | token: ${{ secrets.CODECOV_TOKEN }} 56 | fail_ci_if_error: false 57 | verbose: true 58 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | share/python-wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | MANIFEST 28 | 29 | # PyInstaller 30 | # Usually these files are written by a python script from a template 31 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 32 | *.manifest 33 | *.spec 34 | 35 | # Installer logs 36 | pip-log.txt 37 | pip-delete-this-directory.txt 38 | 39 | # Unit test / coverage reports 40 | htmlcov/ 41 | .tox/ 42 | .nox/ 43 | .coverage 44 | .coverage.* 45 | .cache 46 | nosetests.xml 47 | coverage.xml 48 | *.cover 49 | *.py,cover 50 | .hypothesis/ 51 | .pytest_cache/ 52 | cover/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | .pybuilder/ 76 | target/ 77 | 78 | # Jupyter Notebook 79 | .ipynb_checkpoints 80 | 81 | # IPython 82 | profile_default/ 83 | ipython_config.py 84 | 85 | # pyenv 86 | # For a library or package, you might want to ignore these files since the code is 87 | # intended to run in multiple environments; otherwise, check them in: 88 | # .python-version 89 | 90 | # pipenv 91 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 92 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 93 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 94 | # install all needed dependencies. 95 | #Pipfile.lock 96 | 97 | # poetry 98 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. 99 | # This is especially recommended for binary packages to ensure reproducibility, and is more 100 | # commonly ignored for libraries. 101 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control 102 | #poetry.lock 103 | 104 | # pdm 105 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. 106 | #pdm.lock 107 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it 108 | # in version control. 109 | # https://pdm.fming.dev/#use-with-ide 110 | .pdm.toml 111 | 112 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm 113 | __pypackages__/ 114 | 115 | # Celery stuff 116 | celerybeat-schedule 117 | celerybeat.pid 118 | 119 | # SageMath parsed files 120 | *.sage.py 121 | 122 | # Environments 123 | .env 124 | .venv 125 | env/ 126 | venv/ 127 | ENV/ 128 | env.bak/ 129 | venv.bak/ 130 | 131 | # Spyder project settings 132 | .spyderproject 133 | .spyproject 134 | 135 | # Rope project settings 136 | .ropeproject 137 | 138 | # mkdocs documentation 139 | /site 140 | 141 | # mypy 142 | .mypy_cache/ 143 | .dmypy.json 144 | dmypy.json 145 | 146 | # Pyre type checker 147 | .pyre/ 148 | 149 | # pytype static type analyzer 150 | .pytype/ 151 | 152 | # Cython debug symbols 153 | cython_debug/ 154 | 155 | # PyCharm 156 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can 157 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore 158 | # and can be added to the global gitignore or merged into this file. For a more nuclear 159 | # option (not recommended) you can uncomment the following to ignore the entire idea folder. 160 | #.idea/ 161 | 162 | # pyenv 163 | .python-version 164 | 165 | # pipenv 166 | Pipfile.lock 167 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # CHANGELOG 2 | 3 | ## v0.1.0 4 | 5 | - Migrated templatetags from py-nepali project -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # How to Contribute 2 | 3 | ## Install Development Dependencies (Using Pipenv) 4 | 5 | All the dependencies are managed by Pipenv. Please install Pipenv on your system first by following the instructions at [https://pipenv.pypa.io/en/latest/installation/](https://pipenv.pypa.io/en/latest/installation/). 6 | 7 | Once Pipenv is installed, you can install the development dependencies by running the following command: 8 | 9 | ```bash 10 | make install-dev 11 | ``` 12 | 13 | This will ensure that all the necessary packages and dependencies are installed in your development environment. 14 | 15 | ## Codestyle 16 | 17 | A [.editorconfig](./editorconfig) is available to maintain the coding style. Besides, your code will automatically get formatted if you have installed the pre-commit hook. 18 | 19 | ## Unit tests 20 | 21 | Run the unittest using the below command: 22 | 23 | ```bash 24 | make test 25 | ``` 26 | 27 | ### Coverage Report 28 | 29 | To run the coverage report: 30 | 31 | ```bash 32 | make coverage 33 | ``` 34 | 35 | To generate HTML coverage report 36 | 37 | ```bash 38 | make coverage-html 39 | ``` 40 | 41 | ## Before submitting 42 | 43 | Before submitting your code please do the following steps: 44 | 45 | 1. Add any changes you want 46 | 1. Add tests for the new changes 47 | 1. Update the `CHANGELOG.md` file if necessary 48 | 1. Edit documentation if you have changed something significant 49 | 50 | ## Other help 51 | 52 | You can contribute by spreading a word about this library. 53 | It would also be a huge contribution to write 54 | a short article on how you are using this project. 55 | You can also share your best practices with us. 56 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | ## 2 | # django-nepali 3 | # 4 | # @file 5 | # @version 0.2 6 | 7 | install: 8 | pipenv install 9 | 10 | install-dev: 11 | pipenv install --dev 12 | 13 | test: 14 | pipenv run pytest 15 | 16 | coverage: 17 | pipenv run pytest --cov=django_nepali/ --no-cov-on-fail 18 | 19 | coverage-html: 20 | pipenv run pytest --cov=django_nepali/ --cov-report=html --no-cov-on-fail 21 | 22 | .PHONY: install install-dev test coverage coverage-html 23 | # end 24 | -------------------------------------------------------------------------------- /Pipfile: -------------------------------------------------------------------------------- 1 | [[source]] 2 | url = "https://pypi.org/simple" 3 | verify_ssl = true 4 | name = "pypi" 5 | 6 | [packages] 7 | Django = "*" 8 | nepali = ">=1.0.0" 9 | 10 | [dev-packages] 11 | black = ">=22.1.0" 12 | flake8 = "*" 13 | isort = "*" 14 | pylint = "*" 15 | pytest = "*" 16 | pytest-cov = "*" 17 | pytest-django = "*" 18 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # django-nepali 2 | 3 | [![CI status](https://github.com/opensource-nepal/django-nepali/actions/workflows/python-package.yml/badge.svg?branch=main)](https://github.com/opensource-nepal/django-nepali/actions) 4 | [![Downloads](https://img.shields.io/pypi/dm/django-nepali.svg?maxAge=180)](https://pypi.org/project/django-nepali/) 5 | [![codecov](https://codecov.io/gh/opensource-nepal/django-nepali/branch/main/graph/badge.svg?token=PTUHYWCJ4I)](https://codecov.io/gh/opensource-nepal/django-nepali) 6 | 7 | A django package on top of [nepali](https://github.com/opensource-nepal/py-nepali/) python package which supports nepali date time, time conversion, etc on django projects. 8 | 9 | ## Requirements 10 | 11 | django 12 | nepali >= 1.0.0 13 | 14 | ## Installation 15 | 16 | pip install django-nepali 17 | 18 | On `settings.py`, add `'django_nepali'` to your `INSTALLED_APPS`. 19 | 20 | ```python 21 | INSTALLED_APPS = [ 22 | ... 23 | 'django_nepali', 24 | ... 25 | ] 26 | ``` 27 | 28 | ## Django Templates 29 | 30 | ### nepalidatetime 31 | 32 | In your Template 33 | 34 | ```python 35 | {% load nepalidatetime %} 36 | ``` 37 | 38 | #### nepalinow 39 | 40 | `nepalinow` renders the current Nepali date and time in 'en-US' locale (English). 41 | 42 | ##### For default date format 43 | 44 | ```python 45 | {% nepalinow %} 46 | ``` 47 | 48 | ##### For custom date format 49 | 50 | ```python 51 | {% nepalinow '%Y-%m-%d' %} 52 | ``` 53 | 54 | #### nepalinow_ne 55 | 56 | `nepalinow_ne` renders the current Nepali date and time in 'ne' locale (Nepali). 57 | 58 | ##### For default date format 59 | 60 | ```python 61 | {% nepalinow_ne %} 62 | ``` 63 | 64 | ##### For custom date format 65 | 66 | ``` python 67 | {% nepalinow_ne '%Y-%m-%d' %} 68 | ``` 69 | 70 | #### nepalidate 71 | 72 | `nepalidate` renders the datetime object into nepali datetime format in 'en-US' locale (English). 73 | 74 | ##### For default date format 75 | 76 | ``` python 77 | {{ datetime_obj|nepalidate }} 78 | ``` 79 | 80 | ##### For custom date format 81 | 82 | ```python 83 | {{ datetime_obj|nepalidate:"%Y-%m-%d" }} 84 | ``` 85 | 86 | #### nepalidate_ne 87 | 88 | `nepalidate_ne` renders the datetime object into nepali datetime format in 'ne' locale (Nepali). 89 | 90 | ##### For default date format 91 | 92 | ```python 93 | {{ datetime_obj|nepalidate_ne }} 94 | ``` 95 | 96 | ##### For custom date format 97 | 98 | ```python 99 | {{ datetime_obj|nepalidate_ne:"%Y-%m-%d" }} 100 | ``` 101 | 102 | #### nepalihumanize 103 | 104 | `nepalihumanize` renders the datetime object to a human readable form for 'ne' locale (Nepali) 105 | 106 | ```python 107 | {{ datetime_obj|nepalihumanize }} 108 | ``` 109 | 110 | ##### Humanize threshold 111 | 112 | You can provide a threshold input, measured in seconds, to the `nepalihumanize` filter. If the time difference between the current time and the `datetime_obj` is greater than the specified threshold, then instead of relative time as provided by the humanize function, the `datetime_obj` will be displayed in the specified format (if provided), or else in the default format. 113 | 114 | ```python 115 | {{ datetime_obj|nepalihumanize:1000 }} 116 | ``` 117 | 118 | ### nepalinumber 119 | 120 | In your Template 121 | 122 | ```python 123 | {% load nepalinumber %} 124 | ``` 125 | 126 | `nepalinumber` renders the english number into nepali format (devanagari) 127 | 128 | ```python 129 | {{ forloop.counter|nepalinumber }} 130 | ``` 131 | 132 | ```python 133 | {{ 150|nepalinumber }} 134 | ``` 135 | 136 | ##### nepali_comma 137 | 138 | Renders the given value with commas added in Nepali style without converting the number. 139 | 140 | ```python 141 | {{ number|nepali_comma }} 142 | ``` 143 | 144 | This would convert a number such as `100000` into `1,00,000`. 145 | 146 | ##### english_comma 147 | 148 | Renders the given value with commas added in English style without converting the number. 149 | 150 | ```python 151 | {{ number|english_comma }} 152 | ``` 153 | 154 | This would convert a number such as `100000` into `100,000`. 155 | 156 | ##### nepalinumber with comma 157 | 158 | Converts the number into nepali number and renders it. Basically same as `{{ number|nepalinumber|nepali_comma }}` 159 | 160 | ```python 161 | {{ number|nepalinumber_with_comma }} 162 | ``` 163 | 164 | This would convert a number such as `1000` into `१,०००`. 165 | 166 | ## Contribution 167 | 168 | We appreciate feedback and contribution to this package. To get started please see our [contribution guide](CONTRIBUTING.md) 169 | -------------------------------------------------------------------------------- /codecov.yml: -------------------------------------------------------------------------------- 1 | # This files contains codecov configurations. 2 | 3 | # Disabling comments 4 | comment: false 5 | -------------------------------------------------------------------------------- /django_nepali/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/opensource-nepal/django-nepali/8eacb115454fa552dcace8cf8c86f54300f82c14/django_nepali/__init__.py -------------------------------------------------------------------------------- /django_nepali/templatetags/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/opensource-nepal/django-nepali/8eacb115454fa552dcace8cf8c86f54300f82c14/django_nepali/templatetags/__init__.py -------------------------------------------------------------------------------- /django_nepali/templatetags/nepalidatetime.py: -------------------------------------------------------------------------------- 1 | import datetime 2 | from typing import Optional, Union 3 | 4 | from django import template 5 | from django.utils import timezone 6 | 7 | from nepali.datetime import ( 8 | nepalidate as _nepalidate, 9 | nepalidatetime as _nepalidatetime, 10 | nepalihumanize as humanize 11 | ) 12 | from nepali.exceptions import InvalidNepaliDateTimeObjectException 13 | from nepali.utils import to_nepalidatetime 14 | 15 | _DEFAULT_DATE_FORMAT = "%B %d, %Y, %A" 16 | _datetime = Union[datetime.date, datetime.datetime, _nepalidate, _nepalidatetime] 17 | register = template.Library() 18 | 19 | 20 | @register.filter(name="nepalidate") 21 | def nepalidate( 22 | datetime_obj: _datetime, format: str = _DEFAULT_DATE_FORMAT 23 | ) -> Union[str, None]: 24 | """ 25 | Renders the datetime object into nepali datetime format in 'en-US' locale (English). 26 | 27 | Usage: 28 | ``` 29 | {{ datetime_obj|nepalidate }} 30 | {{ datetime_obj|nepalidate:"%Y-%m-%d" }} 31 | ``` 32 | 33 | :param datetime_obj: Datetime object 34 | :param format: Output format, defaults to "%B %d, %Y, %A" 35 | :returns: Nepali datetime format in 'en-US' locale 36 | """ 37 | return nepalidate_en(datetime_obj, format=format) 38 | 39 | 40 | @register.filter(name="nepalidate_en") 41 | def nepalidate_en( 42 | datetime_obj: _datetime, format: str = _DEFAULT_DATE_FORMAT 43 | ) -> Union[str, None]: 44 | """ 45 | Renders the datetime object into nepali datetime format in 'en-US' locale (English). 46 | 47 | Usage: 48 | ``` 49 | {{ datetime_obj|nepalidate_en }} 50 | {{ datetime_obj|nepalidate_en:"%Y-%m-%d" }} 51 | ``` 52 | 53 | :param datetime_obj: Datetime object 54 | :param format: Output format, defaults to "%B %d, %Y, %A" 55 | :returns: Nepali datetime format in 'en-US' locale 56 | """ 57 | try: 58 | nepali_datetime_obj = to_nepalidatetime(datetime_obj) 59 | return nepali_datetime_obj.strftime_en(format) 60 | except InvalidNepaliDateTimeObjectException: 61 | return "" 62 | 63 | 64 | @register.filter(name="nepalidate_ne") 65 | def nepalidate_ne( 66 | datetime_obj: _datetime, format: str = _DEFAULT_DATE_FORMAT 67 | ) -> Union[str, None]: 68 | """ 69 | Renders the datetime object into nepali datetime format in 'ne' locale (Nepali). 70 | 71 | Usage: 72 | ``` 73 | {{ datetime_obj|nepalidate_ne }} 74 | {{ datetime_obj|nepalidate_ne:"%Y-%m-%d" }} 75 | ``` 76 | 77 | :param datetime_obj: Datetime object 78 | :param format: Output format, defaults to "%B %d, %Y, %A" 79 | :returns: Nepali datetime format in 'ne' locale 80 | """ 81 | try: 82 | nepali_datetime_obj = to_nepalidatetime(datetime_obj) 83 | return nepali_datetime_obj.strftime_ne(format) 84 | except InvalidNepaliDateTimeObjectException: 85 | return "" 86 | 87 | 88 | @register.filter(name="nepalihumanize") 89 | def nepalihumanize( 90 | datetime_obj: _datetime, 91 | threshold: Optional[int] = None, 92 | format: Optional[str] = None, 93 | ) -> Union[str, None]: 94 | """ 95 | Renders the datetime object to a human readable form for 'ne' locale (Nepali). 96 | 97 | Usage: 98 | ``` 99 | {{ datetime_obj|nepalihumanize }} 100 | ``` 101 | 102 | :param datetime_obj: Datetime object 103 | :param threshold: Threshold in seconds that determines when to render 104 | the datetime object in the standard datetime format, optional 105 | :param format: Output format if threshold exceeded, optional 106 | :returns: Datetime object in human readable form 107 | """ 108 | try: 109 | nepali_datetime_obj = to_nepalidatetime(datetime_obj) 110 | return humanize(nepali_datetime_obj, threshold=threshold, format=format) 111 | except InvalidNepaliDateTimeObjectException: 112 | return "" 113 | 114 | 115 | @register.simple_tag 116 | def nepalinow(format: str = _DEFAULT_DATE_FORMAT) -> str: 117 | """ 118 | Renders the current nepali datetime in 'en-US' locale (English). 119 | 120 | Usage: 121 | ``` 122 | {% nepalinow %} 123 | {% nepalinow '%Y-%m-%d' %} 124 | ``` 125 | 126 | :param datetime_obj: Datetime object 127 | :param format: Output format, defaults to "%B %d, %Y, %A" 128 | :returns: Current nepali datetime 129 | """ 130 | return nepalinow_en(format) 131 | 132 | 133 | @register.simple_tag 134 | def nepalinow_en(format: str = _DEFAULT_DATE_FORMAT) -> str: 135 | """ 136 | Renders the current nepali datetime in 'en-US' locale (English). 137 | 138 | Usage: 139 | ``` 140 | {% nepalinow_en %} 141 | {% nepalinow_en '%Y-%m-%d' %} 142 | ``` 143 | 144 | :param datetime_obj: Datetime object 145 | :param format: Output format, defaults to "%B %d, %Y, %A" 146 | :returns: Current nepali datetime 147 | """ 148 | return to_nepalidatetime(timezone.now()).strftime(format) 149 | 150 | 151 | @register.simple_tag 152 | def nepalinow_ne(format: str = _DEFAULT_DATE_FORMAT) -> str: 153 | """ 154 | Renders the current nepali datetime in 'ne' locale (Nepali). 155 | 156 | Usage: 157 | ``` 158 | {% nepalinow_ne %} 159 | {% nepalinow_ne '%Y-%m-%d' %} 160 | ``` 161 | 162 | :param datetime_obj: Datetime object 163 | :param format: Output format, defaults to "%B %d, %Y, %A" 164 | :returns: Current nepali datetime 165 | """ 166 | return to_nepalidatetime(timezone.now()).strftime_ne(format) 167 | -------------------------------------------------------------------------------- /django_nepali/templatetags/nepalinumber.py: -------------------------------------------------------------------------------- 1 | from typing import Any 2 | 3 | from django import template 4 | 5 | from nepali.number import ( 6 | add_comma, 7 | add_comma_english, 8 | convert_and_add_comma, 9 | english_to_nepali, 10 | ) 11 | 12 | register = template.Library() 13 | 14 | 15 | @register.filter(name="nepalinumber") 16 | def nepalinumber(value: Any) -> str: 17 | """ 18 | Converts the number into nepali number and renders it. 19 | 20 | Usage: 21 | ``` 22 | {{ number|nepalinumber }} 23 | ``` 24 | 25 | :param value: Number to be converted 26 | :returns: Nepali output of given number 27 | """ 28 | return english_to_nepali(value) 29 | 30 | 31 | @register.filter(name="nepalinumber_with_comma") 32 | def nepalinumber_with_comma(value: Any) -> str: 33 | """ 34 | Converts the number into nepali number and renders it. 35 | 36 | Usage: 37 | ``` 38 | {{ number|nepalinumber_with_comma }} 39 | ``` 40 | Basically same as `{{ number|nepalinumber|nepali_comma }}` 41 | 42 | :param value: Number to be converted and commas added 43 | :returns: Nepali output of given number with commas 44 | """ 45 | return convert_and_add_comma(value) 46 | 47 | 48 | @register.filter(name="nepali_comma") 49 | def nepali_comma(value: Any) -> str: 50 | """ 51 | Renders the given value with commas added in Nepali style 52 | without converting the number. 53 | 54 | Usage: 55 | ``` 56 | {{ number|nepali_comma }} 57 | ``` 58 | 59 | :param value: Number to be added with commas 60 | :returns: Output of given number with commas 61 | """ 62 | return add_comma(value) 63 | 64 | 65 | @register.filter(name="english_comma") 66 | def english_comma(value: Any) -> str: 67 | """ 68 | Renders the given value with commas added in English style 69 | without converting the number. 70 | 71 | Usage: 72 | ``` 73 | {{ number|english_comma }} 74 | ``` 75 | 76 | :param value: Number to be added with commas 77 | :returns: Output of given number with commas 78 | """ 79 | return add_comma_english(value) 80 | -------------------------------------------------------------------------------- /django_nepali_example/README.md: -------------------------------------------------------------------------------- 1 | ### TODO: Add README for this example project 2 | -------------------------------------------------------------------------------- /django_nepali_example/settings.py: -------------------------------------------------------------------------------- 1 | """ 2 | This file is a django settings file dedicated for 3 | testing purposes 4 | 5 | NOTE: keep it minimal 6 | """ 7 | 8 | DEBUG = True 9 | 10 | INSTALLED_APPS = ("django_nepali",) 11 | 12 | TEMPLATES = [ 13 | { 14 | "BACKEND": "django.template.backends.django.DjangoTemplates", 15 | "DIRS": [], 16 | "APP_DIRS": True, 17 | "OPTIONS": { 18 | # ... some options here ... 19 | }, 20 | }, 21 | ] 22 | 23 | USE_TZ = True 24 | TIME_ZONE = "UTC" 25 | -------------------------------------------------------------------------------- /django_nepali_example/tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/opensource-nepal/django-nepali/8eacb115454fa552dcace8cf8c86f54300f82c14/django_nepali_example/tests/__init__.py -------------------------------------------------------------------------------- /django_nepali_example/tests/template_tags/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/opensource-nepal/django-nepali/8eacb115454fa552dcace8cf8c86f54300f82c14/django_nepali_example/tests/template_tags/__init__.py -------------------------------------------------------------------------------- /django_nepali_example/tests/template_tags/fixtures/nepalidatetime.py: -------------------------------------------------------------------------------- 1 | """ 2 | Contains fixtures for tests related to 3 | nepalidatetime module 4 | """ 5 | 6 | import datetime 7 | 8 | from django.template import Template 9 | from nepali.datetime import nepalidate as _nepalidate 10 | from nepali.datetime import nepalidatetime as _nepalidatetime 11 | 12 | 13 | class NepaliDateFixture: 14 | # common fixtures 15 | template = Template("{% load nepalidatetime %}{{ payload|nepalidate }}") 16 | payload_expected_template = "Jestha 13, 2080, Saturday" 17 | 18 | # fixtures for date(built-in) 19 | date_payload = datetime.date(2023, 5, 27) 20 | 21 | # fixtures for datetime(built-in) 22 | datetime_payload = datetime.datetime(2023, 5, 27, 9, 24, 29) 23 | 24 | # fixtures for nepalidate 25 | nepalidate_payload = _nepalidate(2080, 2, 13) 26 | 27 | # fixtures for nepalidatetime 28 | nepalidatetime_payload = _nepalidatetime(2080, 2, 13) 29 | 30 | # fixtures for errors 31 | invalid_payload = object 32 | 33 | 34 | class NepaliDateEnFixture: 35 | # default/common fixtures 36 | default_template = Template("{% load nepalidatetime %}{{ payload|nepalidate_en }}") 37 | payload_expected_template = "Jestha 24, 2080, Wednesday" 38 | 39 | # custom fixtures 40 | custom_template = Template( 41 | "{% load nepalidatetime %}{{ payload|nepalidate_en:'%Y/%m/%d' }}" 42 | ) 43 | payload_expected_custom_template = "2080/02/24" 44 | 45 | # fixtures for date(built-in) 46 | date_payload = datetime.date(2023, 6, 7) 47 | 48 | # fixtures for datetime(built-in) 49 | datetime_payload = datetime.datetime(2023, 6, 7, 9, 34, 40) 50 | 51 | # fixtures for nepalidate 52 | nepalidate_payload = _nepalidate(2080, 2, 24) 53 | 54 | # fixtures for nepalidatetime 55 | nepalidatetime_payload = _nepalidatetime(2080, 2, 24, 9, 34, 40) 56 | 57 | # fixtures for errors 58 | invalid_payload = object 59 | 60 | 61 | class NepaliDateNeFixture: 62 | # default/common fixtures 63 | default_template = Template("{% load nepalidatetime %}{{ payload|nepalidate_ne }}") 64 | payload_expected_template = "जेठ २४, २०८०, बुधबार" 65 | 66 | # custom fixtures 67 | custom_template = Template( 68 | "{% load nepalidatetime %}{{ payload|nepalidate_ne:'%Y/%m/%d' }}" 69 | ) 70 | payload_expected_custom_template = "२०८०/०२/२४" 71 | 72 | # fixtures for date(built-in) 73 | date_payload = datetime.date(2023, 6, 7) 74 | 75 | # fixtures for datetime(built-in) 76 | datetime_payload = datetime.datetime(2023, 6, 7, 9, 34, 40) 77 | 78 | # fixtures for nepalidate 79 | nepalidate_payload = _nepalidate(2080, 2, 24) 80 | 81 | # fixtures for nepalidatetime 82 | nepalidatetime_payload = _nepalidatetime(2080, 2, 24, 9, 34, 40) 83 | 84 | # fixtures for errors 85 | invalid_payload = object 86 | 87 | 88 | class NepaliHumanizeFixture: 89 | # default/common fixtures 90 | default_template = Template("{% load nepalidatetime %}{{ payload|nepalihumanize }}") 91 | payload_expected_template = "२२ घण्टा अघि" 92 | 93 | # fixtures for date(built-in) 94 | date_payload = datetime.date(2023, 6, 7) 95 | to_nepalidate_return_value_for_date = " 2080-02-24 00:00:00" 96 | 97 | # fixtures for datetime(built-in) 98 | datetime_payload = datetime.datetime(2023, 6, 7, 21, 30) 99 | to_nepalidate_return_value_for_datetime = " 2080-02-24 21:30:00" 100 | 101 | # fixtures for nepalidate 102 | nepalidate_payload = _nepalidate(2080, 2, 24) 103 | to_nepalidate_return_value_for_nepalidate = " 2080-02-24 00:00:00" 104 | 105 | # fixtures for nepalidatetime 106 | nepalidatetime_payload = _nepalidatetime(2080, 2, 24, 21, 30) 107 | to_nepalidate_return_value_for_nepalidatetime = ( 108 | " 2080-02-24 21:30:00" 109 | ) 110 | 111 | # fixtures for error 112 | invalid_payload = object 113 | 114 | 115 | class NepaliNowFixture: 116 | # default values 117 | default_expected_template = "Jestha 25, 2080, Thursday" 118 | default_template = Template("{% load nepalidatetime %}{% nepalinow %}") 119 | default_date_format = "%B %d, %Y, %A" 120 | 121 | # custom values 122 | custom_template = Template("{% load nepalidatetime %}{% nepalinow '%Y/%m/%d' %}") 123 | custom_expected_template = "2080/02/25" 124 | custom_date_format = "%Y/%m/%d" 125 | 126 | 127 | class NepaliNowEnFixture: 128 | # default values 129 | default_expected_template = "Jestha 25, 2080, Thursday" 130 | default_template = Template("{% load nepalidatetime %}{% nepalinow_en %}") 131 | default_date_format = "%B %d, %Y, %A" 132 | 133 | # custom values 134 | custom_template = Template("{% load nepalidatetime %}{% nepalinow_en '%Y/%m/%d' %}") 135 | custom_expected_template = "2080/02/25" 136 | custom_date_format = "%Y/%m/%d" 137 | 138 | # common values 139 | dummy_time = datetime.datetime(2023, 6, 9, 15, 55, 17, 564349) 140 | 141 | 142 | class NepaliNowNeFixture: 143 | # default values 144 | default_expected_template = "जेठ २६, २०८०, शुक्रबार" 145 | default_template = Template("{% load nepalidatetime %}{% nepalinow_ne %}") 146 | default_date_format = "%B %d, %Y, %A" 147 | 148 | # custom values 149 | custom_template = Template("{% load nepalidatetime %}{% nepalinow_ne '%Y/%m/%d' %}") 150 | custom_expected_template = "२०८०/०२/२६" 151 | custom_date_format = "%Y/%m/%d" 152 | 153 | # common values 154 | dummy_time = datetime.datetime(2023, 6, 9, 15, 55, 17, 564349) 155 | -------------------------------------------------------------------------------- /django_nepali_example/tests/template_tags/fixtures/nepalinumber.py: -------------------------------------------------------------------------------- 1 | """ 2 | Contains fixtures for tests related to 3 | nepalinumber module 4 | """ 5 | 6 | from django.template import Template 7 | 8 | 9 | class NepaliNumberFixture: 10 | template = Template("{% load nepalinumber %}{{ payload|nepalinumber }}") 11 | return_value = "१" 12 | 13 | 14 | class NepaliNumberWithCommaFixture: 15 | template = Template("{% load nepalinumber %}{{ payload|nepalinumber_with_comma }}") 16 | return_value = "१,०००" 17 | 18 | 19 | class NepaliCommaFixture: 20 | template = Template("{% load nepalinumber %}{{ payload|nepali_comma }}") 21 | return_value = "1,00,000" 22 | 23 | 24 | class EnglishCommaFixture: 25 | template = Template("{% load nepalinumber %}{{ payload|english_comma }}") 26 | return_value = "100,000" 27 | -------------------------------------------------------------------------------- /django_nepali_example/tests/template_tags/test_nepalidatetime.py: -------------------------------------------------------------------------------- 1 | """ 2 | Contains tests for nepalidatetime.py module 3 | """ 4 | 5 | from unittest import mock 6 | 7 | import pytest 8 | from django.template import Context 9 | 10 | from .fixtures.nepalidatetime import ( 11 | NepaliDateEnFixture, 12 | NepaliDateFixture, 13 | NepaliDateNeFixture, 14 | NepaliHumanizeFixture, 15 | NepaliNowEnFixture, 16 | NepaliNowFixture, 17 | NepaliNowNeFixture, 18 | ) 19 | 20 | MODULE_TO_TEST = "django_nepali.templatetags.nepalidatetime" 21 | 22 | 23 | class TestNepaliDate: 24 | """ 25 | Tests for nepalidate template tag 26 | """ 27 | 28 | @pytest.fixture(scope="class") 29 | def fixture_data(self): 30 | yield NepaliDateFixture() 31 | 32 | def test_nepalidate_returns_empty_string_when_invalid_object_is_passed( 33 | self, fixture_data: NepaliDateFixture 34 | ): 35 | rendered = fixture_data.template.render( 36 | Context({"payload": fixture_data.invalid_payload}) 37 | ) 38 | 39 | assert rendered == "" 40 | 41 | def test_nepalidate_renders_date_in_default_format( 42 | self, fixture_data: NepaliDateFixture 43 | ): 44 | rendered = fixture_data.template.render( 45 | Context({"payload": fixture_data.date_payload}) 46 | ) 47 | 48 | assert rendered == fixture_data.payload_expected_template 49 | 50 | def test_nepalidate_renders_datetime_in_default_format( 51 | self, fixture_data: NepaliDateFixture 52 | ): 53 | rendered = fixture_data.template.render( 54 | Context({"payload": fixture_data.datetime_payload}) 55 | ) 56 | 57 | assert rendered == fixture_data.payload_expected_template 58 | 59 | def test_nepalidate_renders_nepalidate_in_default_format( 60 | self, fixture_data: NepaliDateFixture 61 | ): 62 | rendered = fixture_data.template.render( 63 | Context({"payload": fixture_data.nepalidate_payload}) 64 | ) 65 | 66 | assert rendered == fixture_data.payload_expected_template 67 | 68 | def test_nepalidate_renders_nepalidatetime_in_default_format( 69 | self, fixture_data: NepaliDateFixture 70 | ): 71 | rendered = fixture_data.template.render( 72 | Context({"payload": fixture_data.nepalidatetime_payload}) 73 | ) 74 | 75 | assert rendered == fixture_data.payload_expected_template 76 | 77 | 78 | class TestNepaliDateEn: 79 | """ 80 | Tests for nepalidate_en template tag 81 | """ 82 | 83 | @pytest.fixture(scope="class") 84 | def fixture_data(self): 85 | yield NepaliDateEnFixture() 86 | 87 | def test_nepalidate_en_renders_date_in_default_format( 88 | self, fixture_data: NepaliDateEnFixture 89 | ): 90 | rendered = fixture_data.default_template.render( 91 | Context({"payload": fixture_data.date_payload}) 92 | ) 93 | 94 | assert rendered == fixture_data.payload_expected_template 95 | 96 | def test_nepalidate_en_renders_date_in_custom_format( 97 | self, fixture_data: NepaliDateEnFixture 98 | ): 99 | rendered = fixture_data.custom_template.render( 100 | Context({"payload": fixture_data.date_payload}) 101 | ) 102 | 103 | assert rendered == fixture_data.payload_expected_custom_template 104 | 105 | def test_nepalidate_en_renders_datetime_in_default_format( 106 | self, fixture_data: NepaliDateEnFixture 107 | ): 108 | rendered = fixture_data.default_template.render( 109 | Context({"payload": fixture_data.datetime_payload}) 110 | ) 111 | 112 | assert rendered == fixture_data.payload_expected_template 113 | 114 | def test_nepalidate_en_renders_datetime_in_custom_format( 115 | self, fixture_data: NepaliDateEnFixture 116 | ): 117 | rendered = fixture_data.custom_template.render( 118 | Context({"payload": fixture_data.datetime_payload}) 119 | ) 120 | 121 | assert rendered == fixture_data.payload_expected_custom_template 122 | 123 | def test_nepalidate_en_renders_nepalidate_in_default_format( 124 | self, fixture_data: NepaliDateEnFixture 125 | ): 126 | rendered = fixture_data.default_template.render( 127 | Context({"payload": fixture_data.nepalidate_payload}) 128 | ) 129 | 130 | assert rendered == fixture_data.payload_expected_template 131 | 132 | def test_nepalidate_en_renders_nepalidate_in_custom_format( 133 | self, fixture_data: NepaliDateEnFixture 134 | ): 135 | rendered = fixture_data.custom_template.render( 136 | Context({"payload": fixture_data.nepalidate_payload}) 137 | ) 138 | 139 | assert rendered == fixture_data.payload_expected_custom_template 140 | 141 | def test_nepalidate_en_renders_nepalidatetime_in_default_format( 142 | self, fixture_data: NepaliDateEnFixture 143 | ): 144 | rendered = fixture_data.default_template.render( 145 | Context({"payload": fixture_data.nepalidatetime_payload}) 146 | ) 147 | 148 | assert rendered == fixture_data.payload_expected_template 149 | 150 | def test_nepalidate_en_renders_nepalidatetime_in_custom_format( 151 | self, fixture_data: NepaliDateEnFixture 152 | ): 153 | rendered = fixture_data.custom_template.render( 154 | Context({"payload": fixture_data.nepalidatetime_payload}) 155 | ) 156 | 157 | assert rendered == fixture_data.payload_expected_custom_template 158 | 159 | def test_nepalidate_en_returns_empty_string_when_invalid_object_is_passed( 160 | self, fixture_data: NepaliDateEnFixture 161 | ): 162 | rendered = fixture_data.default_template.render( 163 | Context({"payload": fixture_data.invalid_payload}) 164 | ) 165 | 166 | assert rendered == "" 167 | 168 | 169 | class TestNepaliDateNe: 170 | """ 171 | Tests for nepalidate_ne template tag 172 | """ 173 | 174 | @pytest.fixture(scope="class") 175 | def fixture_data(self): 176 | yield NepaliDateNeFixture() 177 | 178 | def test_nepalidate_en_renders_date_in_default_format( 179 | self, fixture_data: NepaliDateNeFixture 180 | ): 181 | rendered = fixture_data.default_template.render( 182 | Context({"payload": fixture_data.date_payload}) 183 | ) 184 | 185 | assert rendered == fixture_data.payload_expected_template 186 | 187 | def test_nepalidate_en_renders_date_in_custom_format( 188 | self, fixture_data: NepaliDateNeFixture 189 | ): 190 | rendered = fixture_data.custom_template.render( 191 | Context({"payload": fixture_data.date_payload}) 192 | ) 193 | 194 | assert rendered == fixture_data.payload_expected_custom_template 195 | 196 | def test_nepalidate_en_renders_datetime_in_default_format( 197 | self, fixture_data: NepaliDateNeFixture 198 | ): 199 | rendered = fixture_data.default_template.render( 200 | Context({"payload": fixture_data.datetime_payload}) 201 | ) 202 | 203 | assert rendered == fixture_data.payload_expected_template 204 | 205 | def test_nepalidate_en_renders_datetime_in_custom_format( 206 | self, fixture_data: NepaliDateNeFixture 207 | ): 208 | rendered = fixture_data.custom_template.render( 209 | Context({"payload": fixture_data.datetime_payload}) 210 | ) 211 | 212 | assert rendered == fixture_data.payload_expected_custom_template 213 | 214 | def test_nepalidate_en_renders_nepalidate_in_default_format( 215 | self, fixture_data: NepaliDateNeFixture 216 | ): 217 | rendered = fixture_data.default_template.render( 218 | Context({"payload": fixture_data.nepalidate_payload}) 219 | ) 220 | 221 | assert rendered == fixture_data.payload_expected_template 222 | 223 | def test_nepalidate_en_renders_nepalidate_in_custom_format( 224 | self, fixture_data: NepaliDateNeFixture 225 | ): 226 | rendered = fixture_data.custom_template.render( 227 | Context({"payload": fixture_data.nepalidate_payload}) 228 | ) 229 | 230 | assert rendered == fixture_data.payload_expected_custom_template 231 | 232 | def test_nepalidate_en_renders_nepalidatetime_in_default_format( 233 | self, fixture_data: NepaliDateNeFixture 234 | ): 235 | rendered = fixture_data.default_template.render( 236 | Context({"payload": fixture_data.nepalidatetime_payload}) 237 | ) 238 | 239 | assert rendered == fixture_data.payload_expected_template 240 | 241 | def test_nepalidate_en_renders_nepalidatetime_in_custom_format( 242 | self, fixture_data: NepaliDateNeFixture 243 | ): 244 | rendered = fixture_data.custom_template.render( 245 | Context({"payload": fixture_data.nepalidatetime_payload}) 246 | ) 247 | 248 | assert rendered == fixture_data.payload_expected_custom_template 249 | 250 | def test_nepalidate_en_returns_empty_string_when_invalid_object_is_passed( 251 | self, fixture_data: NepaliDateNeFixture 252 | ): 253 | rendered = fixture_data.default_template.render( 254 | Context({"payload": fixture_data.invalid_payload}) 255 | ) 256 | 257 | assert rendered == "" 258 | 259 | 260 | class TestNepaliHumanize: 261 | """ 262 | Tests for nepalihumanize template tag 263 | """ 264 | 265 | @pytest.fixture(scope="class") 266 | def fixture_data(self): 267 | yield NepaliHumanizeFixture() 268 | 269 | @mock.patch(f"{MODULE_TO_TEST}.humanize") 270 | @mock.patch(f"{MODULE_TO_TEST}.to_nepalidatetime") 271 | def test_nepalihumanize_renders_date_in_default_format_with_no_threshold( 272 | self, 273 | mock_to_nepalidatetime: mock.MagicMock, 274 | mock_humanize: mock.MagicMock, 275 | fixture_data: NepaliHumanizeFixture, 276 | ): 277 | # arrange 278 | mock_to_nepalidatetime.return_value = ( 279 | fixture_data.to_nepalidate_return_value_for_date 280 | ) 281 | mock_humanize.return_value = fixture_data.payload_expected_template 282 | 283 | # act 284 | rendered = fixture_data.default_template.render( 285 | Context({"payload": fixture_data.date_payload}) 286 | ) 287 | 288 | # assert 289 | mock_to_nepalidatetime.assert_called_once_with(fixture_data.date_payload) 290 | mock_humanize.assert_called_once_with( 291 | fixture_data.to_nepalidate_return_value_for_date, 292 | threshold=None, 293 | format=None, 294 | ) 295 | assert rendered == fixture_data.payload_expected_template 296 | 297 | @mock.patch(f"{MODULE_TO_TEST}.humanize") 298 | @mock.patch(f"{MODULE_TO_TEST}.to_nepalidatetime") 299 | def test_nepalihumanize_renders_datetime_in_default_format_with_no_threshold( 300 | self, 301 | mock_to_nepalidatetime: mock.MagicMock, 302 | mock_humanize: mock.MagicMock, 303 | fixture_data: NepaliHumanizeFixture, 304 | ): 305 | # arrange 306 | mock_to_nepalidatetime.return_value = ( 307 | fixture_data.to_nepalidate_return_value_for_datetime 308 | ) 309 | mock_humanize.return_value = fixture_data.payload_expected_template 310 | 311 | # act 312 | rendered = fixture_data.default_template.render( 313 | Context({"payload": fixture_data.datetime_payload}) 314 | ) 315 | 316 | # assert 317 | mock_to_nepalidatetime.assert_called_once_with(fixture_data.datetime_payload) 318 | mock_humanize.assert_called_once_with( 319 | fixture_data.to_nepalidate_return_value_for_datetime, 320 | threshold=None, 321 | format=None, 322 | ) 323 | assert rendered == fixture_data.payload_expected_template 324 | 325 | @mock.patch(f"{MODULE_TO_TEST}.humanize") 326 | @mock.patch(f"{MODULE_TO_TEST}.to_nepalidatetime") 327 | def test_nepalihumanize_renders_nepalidate_in_default_format_with_no_threshold( 328 | self, 329 | mock_to_nepalidatetime: mock.MagicMock, 330 | mock_humanize: mock.MagicMock, 331 | fixture_data: NepaliHumanizeFixture, 332 | ): 333 | # arrange 334 | mock_to_nepalidatetime.return_value = ( 335 | fixture_data.to_nepalidate_return_value_for_nepalidate 336 | ) 337 | mock_humanize.return_value = fixture_data.payload_expected_template 338 | 339 | # act 340 | rendered = fixture_data.default_template.render( 341 | Context({"payload": fixture_data.nepalidate_payload}) 342 | ) 343 | 344 | # assert 345 | mock_to_nepalidatetime.assert_called_once_with(fixture_data.nepalidate_payload) 346 | mock_humanize.assert_called_once_with( 347 | fixture_data.to_nepalidate_return_value_for_nepalidate, 348 | threshold=None, 349 | format=None, 350 | ) 351 | assert rendered == fixture_data.payload_expected_template 352 | 353 | @mock.patch(f"{MODULE_TO_TEST}.humanize") 354 | @mock.patch(f"{MODULE_TO_TEST}.to_nepalidatetime") 355 | def test_nepalihumanize_renders_nepalidatetime_in_default_format_with_no_threshold( 356 | self, 357 | mock_to_nepalidatetime: mock.MagicMock, 358 | mock_humanize: mock.MagicMock, 359 | fixture_data: NepaliHumanizeFixture, 360 | ): 361 | # arrange 362 | mock_to_nepalidatetime.return_value = ( 363 | fixture_data.to_nepalidate_return_value_for_nepalidatetime 364 | ) 365 | mock_humanize.return_value = fixture_data.payload_expected_template 366 | 367 | # act 368 | rendered = fixture_data.default_template.render( 369 | Context({"payload": fixture_data.nepalidatetime_payload}) 370 | ) 371 | 372 | # assert 373 | mock_to_nepalidatetime.assert_called_once_with( 374 | fixture_data.nepalidatetime_payload 375 | ) 376 | mock_humanize.assert_called_once_with( 377 | fixture_data.to_nepalidate_return_value_for_nepalidatetime, 378 | threshold=None, 379 | format=None, 380 | ) 381 | assert rendered == fixture_data.payload_expected_template 382 | 383 | def test_nepalihumanize_returns_empty_string_during_error( 384 | self, fixture_data: NepaliHumanizeFixture 385 | ): 386 | rendered = fixture_data.default_template.render( 387 | Context({"payload": fixture_data.invalid_payload}) 388 | ) 389 | 390 | assert rendered == "" 391 | 392 | 393 | class TestNepaliNow: 394 | """ 395 | Tests nepalinow template tag 396 | """ 397 | 398 | @pytest.fixture(scope="class") 399 | def fixture_data(self): 400 | yield NepaliNowFixture() 401 | 402 | @mock.patch(f"{MODULE_TO_TEST}.nepalinow_en") 403 | def test_nepalinow_renders_current_time_in_default_format( 404 | self, mock_nepali_now_en: mock.MagicMock, fixture_data: NepaliNowFixture 405 | ): 406 | # arrange 407 | mock_nepali_now_en.return_value = fixture_data.default_expected_template 408 | 409 | # act 410 | rendered = fixture_data.default_template.render(Context({})) 411 | 412 | # assert 413 | mock_nepali_now_en.assert_called_once_with(fixture_data.default_date_format) 414 | assert rendered == fixture_data.default_expected_template 415 | 416 | @mock.patch(f"{MODULE_TO_TEST}.nepalinow_en") 417 | def test_nepalinow_renders_current_time_in_custom_format( 418 | self, mock_nepali_now_en: mock.MagicMock, fixture_data: NepaliNowFixture 419 | ): 420 | # arrange 421 | mock_nepali_now_en.return_value = fixture_data.custom_expected_template 422 | 423 | # act 424 | rendered = fixture_data.custom_template.render(Context({})) 425 | 426 | # assert 427 | mock_nepali_now_en.assert_called_once_with(fixture_data.custom_date_format) 428 | assert rendered == fixture_data.custom_expected_template 429 | 430 | 431 | class TestNepaliNowEn: 432 | """ 433 | Tests nepalinow_en template tag 434 | """ 435 | 436 | @pytest.fixture(scope="class") 437 | def fixture_data(self): 438 | yield NepaliNowEnFixture() 439 | 440 | @mock.patch(f"{MODULE_TO_TEST}.timezone.now") 441 | @mock.patch(f"{MODULE_TO_TEST}.to_nepalidatetime") 442 | def test_nepalinow_en_renders_current_time_in_default_format( 443 | self, 444 | mock_to_nepalidatetime: mock.MagicMock, 445 | mock_timezone_now: mock.MagicMock, 446 | fixture_data: NepaliNowEnFixture, 447 | ): 448 | mock_to_nepalidatetime.return_value.strftime.return_value = ( 449 | fixture_data.default_expected_template 450 | ) 451 | mock_timezone_now.return_value = fixture_data.dummy_time 452 | 453 | rendered = fixture_data.default_template.render(Context({})) 454 | 455 | mock_timezone_now.assert_called_once() 456 | mock_to_nepalidatetime.assert_called_once_with(fixture_data.dummy_time) 457 | mock_to_nepalidatetime.return_value.strftime.assert_called_once_with( 458 | fixture_data.default_date_format 459 | ) 460 | assert rendered == fixture_data.default_expected_template 461 | 462 | @mock.patch(f"{MODULE_TO_TEST}.timezone.now") 463 | @mock.patch(f"{MODULE_TO_TEST}.to_nepalidatetime") 464 | def test_nepalinow_en_renders_current_time_in_custom_format( 465 | self, 466 | mock_to_nepalidatetime: mock.MagicMock, 467 | mock_timezone_now: mock.MagicMock, 468 | fixture_data: NepaliNowEnFixture, 469 | ): 470 | mock_to_nepalidatetime.return_value.strftime.return_value = ( 471 | fixture_data.custom_expected_template 472 | ) 473 | mock_timezone_now.return_value = fixture_data.dummy_time 474 | 475 | rendered = fixture_data.custom_template.render(Context({})) 476 | 477 | mock_timezone_now.assert_called_once() 478 | mock_to_nepalidatetime.assert_called_once_with(fixture_data.dummy_time) 479 | mock_to_nepalidatetime.return_value.strftime.assert_called_once_with( 480 | fixture_data.custom_date_format 481 | ) 482 | assert rendered == fixture_data.custom_expected_template 483 | 484 | 485 | class TestNepaliNowNe: 486 | """ 487 | Tests nepalinow_ne template tag 488 | """ 489 | 490 | @pytest.fixture(scope="class") 491 | def fixture_data(self): 492 | yield NepaliNowNeFixture() 493 | 494 | @mock.patch(f"{MODULE_TO_TEST}.timezone.now") 495 | @mock.patch(f"{MODULE_TO_TEST}.to_nepalidatetime") 496 | def test_nepalinow_en_renders_current_time_in_default_format( 497 | self, 498 | mock_to_nepalidatetime: mock.MagicMock, 499 | mock_timezone_now: mock.MagicMock, 500 | fixture_data: NepaliNowNeFixture, 501 | ): 502 | mock_to_nepalidatetime.return_value.strftime_ne.return_value = ( 503 | fixture_data.default_expected_template 504 | ) 505 | mock_timezone_now.return_value = fixture_data.dummy_time 506 | 507 | rendered = fixture_data.default_template.render(Context({})) 508 | 509 | mock_timezone_now.assert_called_once() 510 | mock_to_nepalidatetime.assert_called_once_with(fixture_data.dummy_time) 511 | mock_to_nepalidatetime.return_value.strftime_ne.assert_called_once_with( 512 | fixture_data.default_date_format 513 | ) 514 | assert rendered == fixture_data.default_expected_template 515 | 516 | @mock.patch(f"{MODULE_TO_TEST}.timezone.now") 517 | @mock.patch(f"{MODULE_TO_TEST}.to_nepalidatetime") 518 | def test_nepalinow_en_renders_current_time_in_custom_format( 519 | self, 520 | mock_to_nepalidatetime: mock.MagicMock, 521 | mock_timezone_now: mock.MagicMock, 522 | fixture_data: NepaliNowNeFixture, 523 | ): 524 | mock_to_nepalidatetime.return_value.strftime_ne.return_value = ( 525 | fixture_data.custom_expected_template 526 | ) 527 | mock_timezone_now.return_value = fixture_data.dummy_time 528 | 529 | rendered = fixture_data.custom_template.render(Context({})) 530 | 531 | mock_timezone_now.assert_called_once() 532 | mock_to_nepalidatetime.assert_called_once_with(fixture_data.dummy_time) 533 | mock_to_nepalidatetime.return_value.strftime_ne.assert_called_once_with( 534 | fixture_data.custom_date_format 535 | ) 536 | assert rendered == fixture_data.custom_expected_template 537 | -------------------------------------------------------------------------------- /django_nepali_example/tests/template_tags/test_nepalinumber.py: -------------------------------------------------------------------------------- 1 | """ 2 | Contains tests for nepalinumber.py module 3 | """ 4 | 5 | from unittest import mock 6 | 7 | import pytest 8 | from django.template.context import Context 9 | 10 | from .fixtures.nepalinumber import ( 11 | EnglishCommaFixture, 12 | NepaliCommaFixture, 13 | NepaliNumberFixture, 14 | NepaliNumberWithCommaFixture, 15 | ) 16 | 17 | MODULE_TO_TEST = "django_nepali.templatetags.nepalinumber" 18 | 19 | 20 | class TestNepaliNumber: 21 | """ 22 | Tests for nepalinumber template tag 23 | """ 24 | 25 | @pytest.fixture(scope="class") 26 | def fixture_data(self): 27 | yield NepaliNumberFixture() 28 | 29 | @mock.patch(f"{MODULE_TO_TEST}.english_to_nepali") 30 | def test_nepalinumber_returns_nepali_value( 31 | self, mock_english_to_nepali: mock.MagicMock, fixture_data: NepaliNumberFixture 32 | ): 33 | mock_english_to_nepali.return_value = fixture_data.return_value 34 | 35 | rendered = fixture_data.template.render(Context({"payload": 1})) 36 | 37 | mock_english_to_nepali.assert_called_once_with(1) 38 | assert rendered == fixture_data.return_value 39 | 40 | 41 | class TestNepaliNumberWithComma: 42 | """ 43 | Tests for nepalinumber_with_comma template tag 44 | """ 45 | 46 | @pytest.fixture(scope="class") 47 | def fixture_data(self): 48 | yield NepaliNumberWithCommaFixture() 49 | 50 | @mock.patch(f"{MODULE_TO_TEST}.convert_and_add_comma") 51 | def test_nepalinumber_returns_nepali_value_with_comma( 52 | self, 53 | mock_convert_and_add_comma: mock.MagicMock, 54 | fixture_data: NepaliNumberWithCommaFixture, 55 | ): 56 | mock_convert_and_add_comma.return_value = fixture_data.return_value 57 | 58 | rendered = fixture_data.template.render(Context({"payload": 1000})) 59 | 60 | mock_convert_and_add_comma.assert_called_once_with(1000) 61 | assert rendered == fixture_data.return_value 62 | 63 | 64 | class TestNepaliComma: 65 | """ 66 | Tests for nepali_comma template tag 67 | """ 68 | 69 | @pytest.fixture(scope="class") 70 | def fixture_data(self): 71 | yield NepaliCommaFixture() 72 | 73 | @mock.patch(f"{MODULE_TO_TEST}.add_comma") 74 | def test_nepalinumber_returns_number_with_nepali_style_comma( 75 | self, 76 | mock_add_comma: mock.MagicMock, 77 | fixture_data: NepaliCommaFixture, 78 | ): 79 | mock_add_comma.return_value = fixture_data.return_value 80 | 81 | rendered = fixture_data.template.render(Context({"payload": 100000})) 82 | 83 | mock_add_comma.assert_called_once_with(100000) 84 | assert rendered == fixture_data.return_value 85 | 86 | 87 | class TestEnglishComma: 88 | """ 89 | Tests for english_comma template tag 90 | """ 91 | 92 | @pytest.fixture(scope="class") 93 | def fixture_data(self): 94 | yield EnglishCommaFixture() 95 | 96 | @mock.patch(f"{MODULE_TO_TEST}.add_comma_english") 97 | def test_nepalinumber_returns_number_with_english_style_comma( 98 | self, 99 | mock_add_comma_english: mock.MagicMock, 100 | fixture_data: EnglishCommaFixture, 101 | ): 102 | mock_add_comma_english.return_value = fixture_data.return_value 103 | 104 | rendered = fixture_data.template.render(Context({"payload": 100000})) 105 | 106 | mock_add_comma_english.assert_called_once_with(100000) 107 | assert rendered == fixture_data.return_value 108 | -------------------------------------------------------------------------------- /manage.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | import os 4 | import sys 5 | 6 | 7 | if __name__ == "__main__": 8 | os.environ.setdefault("DJANGO_SETTINGS_MODULE", "django_nepali_example.settings") 9 | 10 | from django.core.management import execute_from_command_line 11 | 12 | execute_from_command_line(sys.argv) 13 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [build-system] 2 | requires = ["setuptools", "wheel"] 3 | build-backend = "setuptools.build_meta" -------------------------------------------------------------------------------- /pytest.ini: -------------------------------------------------------------------------------- 1 | [pytest] 2 | DJANGO_SETTINGS_MODULE=django_nepali_example.settings 3 | addopts = -vvv 4 | python_files = test_*.py 5 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [metadata] 2 | name = django-nepali 3 | version = 0.1.0 4 | author = opensource-nepal 5 | author_email = aj3sshh@gmail.com, sugatbajracharya49@gmail.com 6 | description = A django package on top of 'nepali' a python package which supports nepali date time, time conversion, etc on django projects. 7 | long_description = file: README.md 8 | long_description_content_type = text/markdown 9 | keywords = django, nepali date conversion, convert date, nepali date time, python convert date, parse nepali date time 10 | url = https://github.com/opensource-nepal/django-nepali 11 | classifiers = 12 | Programming Language :: Python :: 3 13 | License :: OSI Approved :: GNU General Public License (GPL) 14 | Environment :: Web Environment 15 | Operating System :: OS Independent 16 | Framework :: Django 17 | 18 | [options] 19 | packages = find: 20 | install_requires = 21 | Django 22 | nepali>=1.0.0 23 | --------------------------------------------------------------------------------