Benjamin_Loison/waybackpy
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
akamhy
2020-05-04 20:37:49 +05:30
committed by GitHub
parent 2a456bd39a
commit b4f69d98d8
1 changed files with 10 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@@ -1,5 +1,5 @@
# waybackpy
The waybackpy is python wrapper for [Internet Archive](https://en.wikipedia.org/wiki/Internet_Archive)
The waybackpy is a python wrapper for [Internet Archive](https://en.wikipedia.org/wiki/Internet_Archive)
's [Wayback Machine](https://en.wikipedia.org/wiki/Wayback_Machine).
## Usage
@@ -15,18 +15,18 @@ import waybackpy
archived_url = waybackpy.save("https://github.com/akamhy/waybackpy", UA = "Any-User-Agent")
print(archived_url)
```
This should print something similar to the following archived url:
This should print something similar to the following archived URL:
```
https://web.archive.org/web/20200504141153/https://github.com/akamhy/waybackpy
```
### Retiving the oldest archive for an url. Using oldest().
### Receiving the oldest archive for an URL. Using oldest().
waybackpy.oldest(url, UA=user_agent)
```python
import waybackpy
# retriving the oldest archive on wayback machine.
# retrieving the oldest archive on Wayback machine.
# Default user-agent (UA) is "waybackpy python package", if not specified in the call.
oldest_archive = waybackpy.oldest("https://www.google.com/", UA = "Any-User-Agent")
print(oldest_archive)
@@ -36,23 +36,23 @@ This returns the oldest available archive for <https://google.com> (Check it out
http://web.archive.org/web/19981111184551/http://google.com:80/
```
### Retiving the recent most/newest archive for an url. Using newest().
### Receiving the recent most/newest archive for an URL. Using newest().
waybackpy.newest(url, UA=user_agent)
```python
import waybackpy
# retriving the newest archive on wayback machine.
# retrieving the newest archive on Wayback machine.
# Default user-agent (UA) is "waybackpy python package", if not specified in the call.
newest_archive = waybackpy.newest("https://www.microsoft.com/en-us", UA = "Any-User-Agent")
print(newest_archive)
```
This returns the newest available archive for <https://www.microsoft.com/en-us>, somthing just like this:
This returns the newest available archive for <https://www.microsoft.com/en-us>, something just like this:
```
http://web.archive.org/web/20200429033402/https://www.microsoft.com/en-us/
```
### Retiving archive close to a specified year, month, day, hour and minute! Using near().
### Receiving archive close to a specified year, month, day, hour, and minute! Using near().
waybackpy.newest(url, year=2020, month=1, day=1, hour=1, minute=1, UA=user_agent)
@@ -69,4 +69,5 @@ returns : ```http://web.archive.org/web/20100504071154/http://www.facebook.com/`
```waybackpy.near("https://www.facebook.com/", year=2010, month=1, UA ="Any-User-Agent")``` returns: ```http://web.archive.org/web/20101111173430/http://www.facebook.com//```
```waybackpy.near("https://www.oracle.com/index.html", year=2019, month=1, day=5, UA ="Any-User-Agent")``` returns: ```http://web.archive.org/web/20190105054437/https://www.oracle.com/index.html```
* Please note that if you only specify the year, the current month and day are deafult arguments for month and day respectively. Do not expect just putting the year parameter would return the archive closer to january but the current month you are using the package. If you are using it in July 2018 and lets say you use ```waybackpy.near("https://www.facebook.com/", year=2011, UA ="Any-User-Agent")``` then you would be returned the nearest archive to July 2011 and not January 2011. You need to specify the month "1" for january.
* Please note that if you only specify the year, the current month and day are default arguments for month and day respectively. Do not expect just putting the year parameter would return the archive closer to January but the current month you are using the package. If you are using it in July 2018 and let's say you use ```waybackpy.near("https://www.facebook.com/", year=2011, UA ="Any-User-Agent")``` then you would be returned the nearest archive to July 2011 and not January 2011. You need to specify the month "1" for January.