python-networkdays’s documentation¶
Business days calendar.
JobSchedule on business days.
Tip
Just Python built-in libs, no dependencies
- Networkdays:
Return working days between two dates exclude weekends and holidays.
just like spreadsheets networdays function
exclude Holidays
Exclude “days off” per week.
- Job schedule:
Calculate the period for a given job hours, based on Networdays.
Table of Contents
Installation¶
python-networkdays can be installed from PyPI using pip
pip install python-networkdays
Tip
note that the package name is different from the importable name
Page on Pypi: https://pypi.org/project/python-networkdays/
There is no dependencies.
Features¶
Return a list of business days between 2 dates.
Exclude weekends by default
Custom “days off” may be informed as list like {1,2,3,4,5,6,7}, where 1 is Monday default is {6,7} = (Sat, Sun).
How many business days between two dates.
How many days off, including holidays and weekends.
Return a list of business days for a given number of hours
Return a list of Years, months or weeks for a given number of hours
No Pandas or NumPy dependencies
Examples¶
Networkdays.networkdays()¶
In [1]: from networkdays import networkdays
In [2]: import datetime
In [3]: HOLIDAYS = { datetime.date(2020, 12, 25) } # define a Holidays list
# initiate class::`networkdays.Networkdays`
In [4]: days = networkdays.Networkdays(
datetime.date(2020, 12, 15), # start date
datetime.date(2020, 12, 31), # end date
HOLIDAYS # list of Holidays
)
In [5]: days.networkdays() # return a list os workdays
Out[5]:
[datetime.date(2020, 12, 15),
datetime.date(2020, 12, 16),
datetime.date(2020, 12, 17),
datetime.date(2020, 12, 18),
datetime.date(2020, 12, 21),
datetime.date(2020, 12, 22),
datetime.date(2020, 12, 23),
datetime.date(2020, 12, 24),
datetime.date(2020, 12, 28),
datetime.date(2020, 12, 29),
datetime.date(2020, 12, 30),
datetime.date(2020, 12, 31)]
In [6]: days.weekends() # list os Weekends (default = Saturday ans Sunday)
Out[6]:
[datetime.date(2020, 12, 19),
datetime.date(2020, 12, 20),
datetime.date(2020, 12, 26),
datetime.date(2020, 12, 27)]
In [7]: days.holidays()
Out[7]: [datetime.date(2020, 12, 25)] # list of holidays
Networkdays.jobschedule()¶
# jobSchedule
import datetime
from networkdays import networkdays
# Distribute the 600 hrs of effort, starting on december 1, 2020 working 8hrs per day.
jobschedule = networkdays.JobSchedule(600, 8, datetime.date(2020, 12, 1), networkdays=None)
job_dates = jobschedule.job_workdays()
# print results ...
print(f'''
bussines days: {jobschedule.bussines_days}
calendar days: {jobschedule.total_days}
starts - ends: {jobschedule.prj_starts} - {jobschedule.prj_ends}
years: {list(jobschedule.years())}
months: {list(jobschedule.months())}
weeks (ISO): {list(jobschedule.weeks())}
days:
{list(jobschedule.days())[:2]} ...\n ...{list(jobschedule.days())[-2:]}
Works days dates on january:
{list(jobschedule.days())[:2]} ...\n ...{list(jobschedule.days())[-2:]}
''')
bussines days: 54
calendar days: 73 days, 0:00:00
starts - ends: 12/01/20 - 02/12/21
years: [2020, 2021]
months: [12, 1, 2]
weeks (ISO): [49, 50, 51, 52, 53, 1, 2, 3, 4, 5, 6]
days:
[datetime.date(2020, 12, 1), datetime.date(2020, 12, 2)] ...
...[datetime.date(2021, 2, 11), datetime.date(2021, 2, 12)]
Works days dates on january:
[datetime.date(2020, 12, 1), datetime.date(2020, 12, 2)] ...
...[datetime.date(2021, 2, 11), datetime.date(2021, 2, 12)]
Other similar projects¶
When I start to code, I did check for some similar projects.
I knew about python-dateutil, a great project I use for years… I’d like something more straightforward or simpler.
After to publish the python-networkdays on PyPi I found some others 8(
workdays : A 5 years old project, looks the same as networkdays_
timeboard : A more complex but powerful project
python-dateutil is great, powerful but even more complex.
python-bizdays : Quick simple and direct …
I will try to keep this list updated…