npdatetime 0.1.1__tar.gz → 0.1.2.post2__tar.gz

npdatetime-0.1.2.post2/.github/workflows/python-publish.yml

@@ -0,0 +1,54 @@
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.9"  # Specify a precise Python version
+
+      - name: Build release distributions
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install build
+          python -m build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+  pypi-publish:
+    runs-on: ubuntu-latest
+    needs:
+      - release-build
+    permissions:
+      id-token: write
+
+    environment:
+      name: pypi
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/
+          token: ${{ secrets.PYPI_API_TOKEN }}

{npdatetime-0.1.1 → npdatetime-0.1.2.post2}/.gitignore

@@ -19,4 +19,6 @@ docs/source/_*
 
 /*.egg-info/
 
-dist/
+dist/
+
+RELEASE_NOTES.md

npdatetime-0.1.2.post2/CONTRIBUTING.md

@@ -0,0 +1,122 @@
+# CONTRIBUTING  
+
+Thank you for your interest in contributing to the **npdatetime** project! 🎉  
+We welcome contributions that improve functionality, fix bugs, enhance documentation, or add new features. Follow the guidelines below to get started.  
+
+---
+
+## Getting Started  
+
+1. **Fork the Repository**  
+   Create your own copy of the repository by clicking the "Fork" button on GitHub.  
+
+2. **Clone Your Fork**  
+   Clone your forked repository to your local machine:  
+   ```bash  
+   git clone https://github.com/4mritGiri/npdatetime.git  
+   cd npdatetime  
+   ```  
+
+3. **Install in Editable Mode**  
+   Install the package in editable mode to reflect your changes immediately:  
+   ```bash  
+   pip install -e .  
+   ```  
+
+4. **Install Development Dependencies**  
+   Install the necessary tools for testing and formatting:  
+   ```bash  
+   pip install pytest flake8  
+   ```  
+
+---
+
+## Contribution Workflow  
+
+### 1. Run Tests  
+Before making any changes, ensure all existing tests pass:  
+```bash  
+pytest  
+```  
+
+### 2. Format Your Code  
+Check for code formatting issues:  
+```bash  
+flake8 npdatetime --max-line-length=120  
+```  
+
+### 3. Create a New Branch  
+Create a new branch for your changes based on the `develop` branch:  
+```bash  
+git checkout develop  
+git checkout -b feature/<your-feature-name>  
+```  
+
+### 4. Make Your Changes  
+- Write clear, maintainable, and well-documented code.  
+- Add tests for new features or bug fixes, if applicable.  
+- Address any *TODOs* in the code if relevant.  
+
+### 5. Verify Your Changes  
+Before committing, ensure all tests pass and there are no formatting issues:  
+```bash  
+pytest  
+flake8 npdatetime --max-line-length=120  
+```  
+
+### 6. Commit Your Changes  
+Write descriptive commit messages following this format:  
+```bash  
+git commit -m "Fix: Correct calculation in npdatetime function"  
+```  
+
+### 7. Push and Open a Pull Request  
+Push your changes to your fork and open a Pull Request (PR) against the `develop` branch of the original repository:  
+```bash  
+git push origin <your-branch-name>  
+```  
+In your PR:  
+- Provide a clear description of the changes made.  
+- Reference any related issues or bugs.  
+
+---
+
+## Preparing a New Release  
+
+### 1. Create a Release Branch  
+Checkout from the `develop` branch and create a new branch for the release:  
+```bash  
+git checkout develop  
+git checkout -b release/v0.2.2  
+```  
+
+### 2. Tag the Release  
+Use Git tags for versioning:  
+```bash  
+git tag -a v0.2.2 -m "Release version 0.2.2"  
+git push origin --tags  
+```  
+
+---
+
+## Additional Notes  
+
+- **Finding Tasks**: Look for *TODO* comments in the code to identify areas needing attention.  
+- **Style Guide**: Follow PEP 8 for Python code formatting.  
+- **Communication**: For significant changes, please open an issue to discuss your ideas before submitting a PR.  
+
+---
+
+**Thank you for contributing to npdatetime!**  
+Your efforts help make this project better for everyone. 💪  
+If you have any questions, feel free to open an issue or reach out on the project's discussion board.  
+
+#### 🎉 ***Happy Coding!*** 🎉  
+
+---  
+
+### Improvements in This Version  
+1. Removed redundant steps in the release process to align with Git tag-based versioning.  
+2. Simplified and clarified branching instructions.  
+3. Organized sections for better readability.  
+4. Encouraged contributor engagement with a friendly tone.  

npdatetime-0.1.2.post2/PKG-INFO

@@ -0,0 +1,273 @@
+Metadata-Version: 2.1
+Name: npdatetime
+Version: 0.1.2.post2
+Summary: A Python package that provides advanced functionality for handling Nepali dates and times, including support for the Bikram Sambat calendar system and Nepal Time (NPT). Ideal for developers working with Nepali date-related applications, offering seamless conversion, manipulation, and formatting of dates and times in the Nepali calendar.
+Home-page: https://github.com/4mritGiri/npdatetime
+Author: Amrit Giri
+Author-email: Amrit Giri <amritgiri02595@gmail.com>
+License: The MIT License (MIT)
+        Copyright © 2020 AMRIT GIRI
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the “Software”), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in
+        all copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+        THE SOFTWARE.
+Project-URL: Homepage, https://github.com/4mritGiri/npdatetime#readme
+Project-URL: Issues, https://github.com/4mritGiri/npdatetime/issues
+Keywords: Nepali Date,Date Conversion,Datetime,Bikram Sambat,Bikram Samvat,nepali,B.S.,BS,bs,b.s,date,NpDateTime,datetime,time,timezone,nepal,bikram,sambat,samvat,nepali-date,nepali-datetime,nepal-time,npt,nepal-timezone,npdatetime,npdt
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.5
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# **Nepali Datetime (Bikram Sambat Date & Nepal Time)**  
+
+A Python library inspired by Python's core `datetime` module, designed specifically for operations based on the **Bikram Sambat (B.S.)** calendar and **Nepal Time (NPT)** timezone (`UTC+05:45`).  
+
+This library bridges the gap between traditional Nepali dates and modern software development, allowing developers to handle Nepali dates with ease while maintaining compatibility with Python's `datetime`.  
+
+---
+
+## **Key Features**  
+
+- Full support for Bikram Sambat (B.S.) date operations.  
+- Handles Nepal Time (NPT) seamlessly (`UTC+05:45`).  
+- Built-in compatibility with Python's `datetime` module.  
+- Supports date formatting with Nepali Unicode for localized output.  
+- Conversion between Bikram Sambat and Gregorian calendars.  
+- Convenient utilities for date parsing, arithmetic, and calendars.  
+- Compatible with Python 3.5 and above.  
+
+---
+
+## **Installation**  
+
+Install the package via `pip`:  
+```bash  
+pip install npdatetime  
+```  
+
+---
+
+## **Quick Start**  
+
+Here's how you can use `npdatetime` alongside Python's standard `datetime` module:  
+
+### **Importing**  
+```python  
+import datetime  
+import npdatetime  
+```  
+
+### **Getting Today's Date**  
+```python  
+# Gregorian date  
+datetime.date.today()  
+
+# Bikram Sambat date  
+npdatetime.date.today()  
+```  
+
+### **Current Date and Time**  
+```python  
+# Gregorian datetime  
+datetime.datetime.now()  
+
+# Bikram Sambat datetime  
+npdatetime.datetime.now()  
+```  
+
+---
+
+## **Key Functionalities**  
+
+### **Creating Date and Datetime Objects**  
+```python  
+# Gregorian date  
+datetime.date(2020, 9, 4)  
+
+# Bikram Sambat date  
+npdatetime.date(2077, 5, 19)  
+
+# Gregorian datetime  
+datetime.datetime(2020, 9, 4, 8, 26, 10, 123456)  
+
+# Bikram Sambat datetime  
+npdatetime.datetime(2077, 5, 19, 8, 26, 10, 123456)  
+```  
+
+### **Date Formatting with Localization**  
+```python  
+# Formatting a Bikram Sambat date  
+npdatetime.datetime(2077, 5, 19).strftime("%d %B %Y")  
+# Output: 19 Bhadau 2077  
+
+# Formatting with Nepali Unicode  
+npdatetime.date(2077, 10, 25).strftime('%K-%n-%D (%k %N %G)')  
+# Output: २०७७-१०-२५ (२५ माघ आइतबार)  
+```  
+
+### **Parsing Dates from Strings**  
+```python  
+npdatetime.datetime.strptime('2077-09-12', '%Y-%m-%d')  
+# Output: npdatetime.datetime(2077, 9, 12, 0, 0)  
+```  
+
+### **Timedelta Operations**  
+```python  
+# Adding days to a date  
+npdatetime.date(1990, 5, 10) + datetime.timedelta(days=350)  
+# Output: npdatetime.date(1991, 4, 26)  
+
+# Adding hours and minutes to a datetime  
+npdatetime.datetime(1990, 5, 10, 5, 10) + datetime.timedelta(hours=3, minutes=15)  
+# Output: npdatetime.datetime(1990, 5, 10, 8, 25)  
+```  
+
+### **Bikram Sambat <-> Gregorian Conversion**  
+```python  
+# Convert Bikram Sambat to Gregorian  
+npdatetime.date(1999, 7, 25).to_datetime_date()  
+# Output: datetime.date(1942, 11, 10)  
+
+# Convert Gregorian to Bikram Sambat  
+npdatetime.date.from_datetime_date(datetime.date(1942, 11, 10))  
+# Output: npdatetime.date(1999, 7, 25)  
+```  
+
+### **Bikram Sambat Monthly Calendar**  
+```python  
+npdatetime.date(2078, 1, 1).calendar()  
+
+# Output:  
+          Baishakh 2078  
+Sun  Mon  Tue  Wed  Thu  Fri  Sat  
+                1    2    3    4  
+5     6    7    8    9   10   11  
+12   13   14   15   16   17   18  
+19   20   21   22   23   24   25  
+26   27   28   29   30   31  
+```  
+
+---
+
+## **Fiscal Year Calculations**
+
+The **npdatetime** library provides methods to easily calculate the current fiscal year and convert dates to their corresponding fiscal year. Fiscal years in Nepal start from **Shrawan (month 4)** and end at **Ashadh (month 12)**.
+
+### **Getting the Current Fiscal Year**
+You can get the current fiscal year using the `current_fiscal_year()` method. It returns the fiscal year as a tuple in the format `(start_year, end_year)`.
+
+```python
+import npdatetime
+
+# Get current fiscal year
+npdatetime.datetime.current_fiscal_year()
+# Output: (2081, 2082)
+```
+
+Alternatively, you can use it directly from the `datetime` class:
+
+```python
+from npdatetime import datetime
+
+# Get current fiscal year
+datetime.current_fiscal_year()
+# Output: (2081, 2082)
+```
+
+### **Getting Fiscal Year for a Specific Date**
+You can also calculate the fiscal year for any specific Nepali date using the `get_fiscal_year_by_date()` function. This takes a `datetime` object as input and returns the fiscal year for that date.
+
+```python
+from npdatetime import get_fiscal_year_by_date
+from npdatetime import datetime
+
+# Example date
+date_obj = datetime(2079, 12, 1)
+
+# Get fiscal year for a specific date
+get_fiscal_year_by_date(date_obj)
+# Output: (2079, 2080)
+
+# You can also directly pass a Nepali datetime object to the function
+get_fiscal_year_by_date(datetime(2080, 4, 1))
+# Output: (2080, 2081)
+```
+
+### **Examples**
+
+Here are a few examples of how you can use the `get_fiscal_year_by_date()` method to calculate the fiscal year for various dates:
+
+```python
+# For 2079-12-01
+get_fiscal_year_by_date(datetime(2079, 12, 1))
+# Output: (2079, 2080)
+
+# For 2080-03-01
+get_fiscal_year_by_date(datetime(2080, 3, 1))
+# Output: (2079, 2080)
+
+# For 2080-04-01
+get_fiscal_year_by_date(datetime(2080, 4, 1))
+# Output: (2080, 2081)
+
+# For 2080-06-01
+get_fiscal_year_by_date(datetime(2080, 6, 1))
+# Output: (2080, 2081)
+```
+
+### **Note**
+- The fiscal year is based on the Nepali date system, which is different from the Gregorian calendar. In Nepal, the fiscal year runs from **Shrawan (month 4)** to **Ashadh (month 12)**.
+
+---
+
+## **Documentation**  
+
+Comprehensive usage examples and detailed documentation can be found on the [official website](https://4mritGiri.github.io/npdatetime/).  
+
+---
+
+## **Contributing**  
+
+We welcome contributions! If you'd like to contribute, check out the [CONTRIBUTING.md](https://github.com/4mritGiri/npdatetime/blob/master/CONTRIBUTING.md) guide for details on how to get started.  
+
+---
+
+## **License**  
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.  
+
+---
+
+## **Feedback & Support**  
+
+For feature requests, bug reports, or feedback, please create an issue on the [GitHub repository](https://github.com/4mritGiri/npdatetime/issues).  
+
+---
+
+### 🌟 **Made for Developers, by Developers** 🌟  
+Your feedback and support are invaluable in making **npdatetime** the go-to library for working with Nepali dates. Thank you! 🙌  
+
+---  
+
+### **Improvements in This Version**  
+1. Enhanced structure with logical sections for better readability.  
+2. Highlighted key functionalities for quick reference.  
+3. Added friendly language to engage contributors and users.  
+4. Updated examples to be more illustrative and user-friendly.  

npdatetime-0.1.2.post2/README.md

@@ -0,0 +1,236 @@
+# **Nepali Datetime (Bikram Sambat Date & Nepal Time)**  
+
+A Python library inspired by Python's core `datetime` module, designed specifically for operations based on the **Bikram Sambat (B.S.)** calendar and **Nepal Time (NPT)** timezone (`UTC+05:45`).  
+
+This library bridges the gap between traditional Nepali dates and modern software development, allowing developers to handle Nepali dates with ease while maintaining compatibility with Python's `datetime`.  
+
+---
+
+## **Key Features**  
+
+- Full support for Bikram Sambat (B.S.) date operations.  
+- Handles Nepal Time (NPT) seamlessly (`UTC+05:45`).  
+- Built-in compatibility with Python's `datetime` module.  
+- Supports date formatting with Nepali Unicode for localized output.  
+- Conversion between Bikram Sambat and Gregorian calendars.  
+- Convenient utilities for date parsing, arithmetic, and calendars.  
+- Compatible with Python 3.5 and above.  
+
+---
+
+## **Installation**  
+
+Install the package via `pip`:  
+```bash  
+pip install npdatetime  
+```  
+
+---
+
+## **Quick Start**  
+
+Here's how you can use `npdatetime` alongside Python's standard `datetime` module:  
+
+### **Importing**  
+```python  
+import datetime  
+import npdatetime  
+```  
+
+### **Getting Today's Date**  
+```python  
+# Gregorian date  
+datetime.date.today()  
+
+# Bikram Sambat date  
+npdatetime.date.today()  
+```  
+
+### **Current Date and Time**  
+```python  
+# Gregorian datetime  
+datetime.datetime.now()  
+
+# Bikram Sambat datetime  
+npdatetime.datetime.now()  
+```  
+
+---
+
+## **Key Functionalities**  
+
+### **Creating Date and Datetime Objects**  
+```python  
+# Gregorian date  
+datetime.date(2020, 9, 4)  
+
+# Bikram Sambat date  
+npdatetime.date(2077, 5, 19)  
+
+# Gregorian datetime  
+datetime.datetime(2020, 9, 4, 8, 26, 10, 123456)  
+
+# Bikram Sambat datetime  
+npdatetime.datetime(2077, 5, 19, 8, 26, 10, 123456)  
+```  
+
+### **Date Formatting with Localization**  
+```python  
+# Formatting a Bikram Sambat date  
+npdatetime.datetime(2077, 5, 19).strftime("%d %B %Y")  
+# Output: 19 Bhadau 2077  
+
+# Formatting with Nepali Unicode  
+npdatetime.date(2077, 10, 25).strftime('%K-%n-%D (%k %N %G)')  
+# Output: २०७७-१०-२५ (२५ माघ आइतबार)  
+```  
+
+### **Parsing Dates from Strings**  
+```python  
+npdatetime.datetime.strptime('2077-09-12', '%Y-%m-%d')  
+# Output: npdatetime.datetime(2077, 9, 12, 0, 0)  
+```  
+
+### **Timedelta Operations**  
+```python  
+# Adding days to a date  
+npdatetime.date(1990, 5, 10) + datetime.timedelta(days=350)  
+# Output: npdatetime.date(1991, 4, 26)  
+
+# Adding hours and minutes to a datetime  
+npdatetime.datetime(1990, 5, 10, 5, 10) + datetime.timedelta(hours=3, minutes=15)  
+# Output: npdatetime.datetime(1990, 5, 10, 8, 25)  
+```  
+
+### **Bikram Sambat <-> Gregorian Conversion**  
+```python  
+# Convert Bikram Sambat to Gregorian  
+npdatetime.date(1999, 7, 25).to_datetime_date()  
+# Output: datetime.date(1942, 11, 10)  
+
+# Convert Gregorian to Bikram Sambat  
+npdatetime.date.from_datetime_date(datetime.date(1942, 11, 10))  
+# Output: npdatetime.date(1999, 7, 25)  
+```  
+
+### **Bikram Sambat Monthly Calendar**  
+```python  
+npdatetime.date(2078, 1, 1).calendar()  
+
+# Output:  
+          Baishakh 2078  
+Sun  Mon  Tue  Wed  Thu  Fri  Sat  
+                1    2    3    4  
+5     6    7    8    9   10   11  
+12   13   14   15   16   17   18  
+19   20   21   22   23   24   25  
+26   27   28   29   30   31  
+```  
+
+---
+
+## **Fiscal Year Calculations**
+
+The **npdatetime** library provides methods to easily calculate the current fiscal year and convert dates to their corresponding fiscal year. Fiscal years in Nepal start from **Shrawan (month 4)** and end at **Ashadh (month 12)**.
+
+### **Getting the Current Fiscal Year**
+You can get the current fiscal year using the `current_fiscal_year()` method. It returns the fiscal year as a tuple in the format `(start_year, end_year)`.
+
+```python
+import npdatetime
+
+# Get current fiscal year
+npdatetime.datetime.current_fiscal_year()
+# Output: (2081, 2082)
+```
+
+Alternatively, you can use it directly from the `datetime` class:
+
+```python
+from npdatetime import datetime
+
+# Get current fiscal year
+datetime.current_fiscal_year()
+# Output: (2081, 2082)
+```
+
+### **Getting Fiscal Year for a Specific Date**
+You can also calculate the fiscal year for any specific Nepali date using the `get_fiscal_year_by_date()` function. This takes a `datetime` object as input and returns the fiscal year for that date.
+
+```python
+from npdatetime import get_fiscal_year_by_date
+from npdatetime import datetime
+
+# Example date
+date_obj = datetime(2079, 12, 1)
+
+# Get fiscal year for a specific date
+get_fiscal_year_by_date(date_obj)
+# Output: (2079, 2080)
+
+# You can also directly pass a Nepali datetime object to the function
+get_fiscal_year_by_date(datetime(2080, 4, 1))
+# Output: (2080, 2081)
+```
+
+### **Examples**
+
+Here are a few examples of how you can use the `get_fiscal_year_by_date()` method to calculate the fiscal year for various dates:
+
+```python
+# For 2079-12-01
+get_fiscal_year_by_date(datetime(2079, 12, 1))
+# Output: (2079, 2080)
+
+# For 2080-03-01
+get_fiscal_year_by_date(datetime(2080, 3, 1))
+# Output: (2079, 2080)
+
+# For 2080-04-01
+get_fiscal_year_by_date(datetime(2080, 4, 1))
+# Output: (2080, 2081)
+
+# For 2080-06-01
+get_fiscal_year_by_date(datetime(2080, 6, 1))
+# Output: (2080, 2081)
+```
+
+### **Note**
+- The fiscal year is based on the Nepali date system, which is different from the Gregorian calendar. In Nepal, the fiscal year runs from **Shrawan (month 4)** to **Ashadh (month 12)**.
+
+---
+
+## **Documentation**  
+
+Comprehensive usage examples and detailed documentation can be found on the [official website](https://4mritGiri.github.io/npdatetime/).  
+
+---
+
+## **Contributing**  
+
+We welcome contributions! If you'd like to contribute, check out the [CONTRIBUTING.md](https://github.com/4mritGiri/npdatetime/blob/master/CONTRIBUTING.md) guide for details on how to get started.  
+
+---
+
+## **License**  
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.  
+
+---
+
+## **Feedback & Support**  
+
+For feature requests, bug reports, or feedback, please create an issue on the [GitHub repository](https://github.com/4mritGiri/npdatetime/issues).  
+
+---
+
+### 🌟 **Made for Developers, by Developers** 🌟  
+Your feedback and support are invaluable in making **npdatetime** the go-to library for working with Nepali dates. Thank you! 🙌  
+
+---  
+
+### **Improvements in This Version**  
+1. Enhanced structure with logical sections for better readability.  
+2. Highlighted key functionalities for quick reference.  
+3. Added friendly language to engage contributors and users.  
+4. Updated examples to be more illustrative and user-friendly.