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

fix: format md and yml (#129)

Browse Source
This commit is contained in:
eggplants 2022-02-05 02:01:46 +09:00 committed by GitHub
parent e61447effd
commit 320ef30371
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 42 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
.github/ISSUE_TEMPLATE/bug_report.md vendored
View File

@ -12,6 +12,7 @@ A clear and concise description of what the bug is.
**To Reproduce** **To Reproduce**
Steps to reproduce the behavior: Steps to reproduce the behavior:
1. Go to '...' 1. Go to '...'
2. Click on '....' 2. Click on '....'
3. Scroll down to '....' 3. Scroll down to '....'
@ -24,9 +25,10 @@ A clear and concise description of what you expected to happen.
If applicable, add screenshots to help explain your problem. If applicable, add screenshots to help explain your problem.
**Version:** **Version:**
- OS: [e.g. iOS]
- Version [e.g. 22] - OS: [e.g. iOS]
- Is latest version? [e.g. Yes/No] - Version [e.g. 22]
- Is latest version? [e.g. Yes/No]
**Additional context** **Additional context**
Add any other context about the problem here. Add any other context about the problem here.

1
.github/ISSUE_TEMPLATE/feature_request.md vendored
View File

@ -4,7 +4,6 @@ about: Suggest an idea for this project
title: '' title: ''
labels: enhancement labels: enhancement
assignees: akamhy assignees: akamhy
--- ---
**Is your feature request related to a problem? Please describe.** **Is your feature request related to a problem? Please describe.**

6
CODE_OF_CONDUCT.md
View File

@ -116,7 +116,7 @@ the community.
This Code of Conduct is adapted from the [Contributor Covenant][homepage], This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. <https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
Community Impact Guidelines were inspired by [Mozilla's code of conduct Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity). enforcement ladder](https://github.com/mozilla/diversity).
@ -124,5 +124,5 @@ enforcement ladder](https://github.com/mozilla/diversity).
[homepage]: https://www.contributor-covenant.org [homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see the FAQ at For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at <https://www.contributor-covenant.org/faq>. Translations are available at
https://www.contributor-covenant.org/translations. <https://www.contributor-covenant.org/translations>.

16
CONTRIBUTORS.md
View File

@ -1,9 +1,13 @@
# CONTRIBUTORS
## AUTHORS ## AUTHORS
- akamhy (<https://github.com/akamhy>)
- danvalen1 (<https://github.com/danvalen1>) - akamhy (<https://github.com/akamhy>)
- AntiCompositeNumber (<https://github.com/AntiCompositeNumber>) - danvalen1 (<https://github.com/danvalen1>)
- jonasjancarik (<https://github.com/jonasjancarik>) - AntiCompositeNumber (<https://github.com/AntiCompositeNumber>)
- jonasjancarik (<https://github.com/jonasjancarik>)
## ACKNOWLEDGEMENTS ## ACKNOWLEDGEMENTS
- mhmdiaa (<https://github.com/mhmdiaa>) for <https://gist.github.com/mhmdiaa/adf6bff70142e5091792841d4b372050>. known_urls is based on this gist.
- dequeued0 (<https://github.com/dequeued0>) for reporting bugs and useful feature requests. - mhmdiaa (<https://github.com/mhmdiaa>) for <https://gist.github.com/mhmdiaa/adf6bff70142e5091792841d4b372050>. known_urls is based on this gist.
- dequeued0 (<https://github.com/dequeued0>) for reporting bugs and useful feature requests.

37
README.md
View File

@ -1,3 +1,4 @@
<!-- markdownlint-disable MD033 MD041 -->
<div align="center"> <div align="center">
<img src="https://raw.githubusercontent.com/akamhy/waybackpy/master/assets/waybackpy_logo.svg"><br> <img src="https://raw.githubusercontent.com/akamhy/waybackpy/master/assets/waybackpy_logo.svg"><br>
@ -15,21 +16,21 @@
<a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a> <a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
</p> </p>
----------------------------------------------------------------------------------------------------------------------------------------------- ---
# ⭐️ Introduction
## ⭐️ Introduction
Waybackpy is a [Python package](https://www.udacity.com/blog/2021/01/what-is-a-python-package.html) and a [CLI](https://www.w3schools.com/whatis/whatis_cli.asp) tool that interfaces with the [Wayback Machine](https://en.wikipedia.org/wiki/Wayback_Machine) API. Waybackpy is a [Python package](https://www.udacity.com/blog/2021/01/what-is-a-python-package.html) and a [CLI](https://www.w3schools.com/whatis/whatis_cli.asp) tool that interfaces with the [Wayback Machine](https://en.wikipedia.org/wiki/Wayback_Machine) API.
Wayback Machine has 3 client side [API](https://www.redhat.com/en/topics/api/what-are-application-programming-interfaces)s. Wayback Machine has 3 client side [API](https://www.redhat.com/en/topics/api/what-are-application-programming-interfaces)s.
- [Save API](https://github.com/akamhy/waybackpy/wiki/Wayback-Machine-APIs#save-api) - [Save API](https://github.com/akamhy/waybackpy/wiki/Wayback-Machine-APIs#save-api)
- [Availability API](https://github.com/akamhy/waybackpy/wiki/Wayback-Machine-APIs#availability-api) - [Availability API](https://github.com/akamhy/waybackpy/wiki/Wayback-Machine-APIs#availability-api)
- [CDX API](https://github.com/akamhy/waybackpy/wiki/Wayback-Machine-APIs#cdx-api) - [CDX API](https://github.com/akamhy/waybackpy/wiki/Wayback-Machine-APIs#cdx-api)
These three APIs can be accessed via the waybackpy either by importing it in a script or from the CLI. These three APIs can be accessed via the waybackpy either by importing it in a script or from the CLI.
## 🏗 Installation
### 🏗 Installation
**Using [pip](https://en.wikipedia.org/wiki/Pip_(package_manager)), from [PyPI](https://pypi.org/) (recommended)**: **Using [pip](https://en.wikipedia.org/wiki/Pip_(package_manager)), from [PyPI](https://pypi.org/) (recommended)**:
@ -37,7 +38,6 @@ These three APIs can be accessed via the waybackpy either by importing it in a s
pip install waybackpy pip install waybackpy
``` ```
**Using [conda](https://en.wikipedia.org/wiki/Conda_(package_manager)), from [conda-forge](https://anaconda.org/conda-forge/waybackpy) (recommended)**: **Using [conda](https://en.wikipedia.org/wiki/Conda_(package_manager)), from [conda-forge](https://anaconda.org/conda-forge/waybackpy) (recommended)**:
See also [waybackpy feedstock](https://github.com/conda-forge/waybackpy-feedstock), maintainers are [@rafaelrdealmeida](https://github.com/rafaelrdealmeida/), See also [waybackpy feedstock](https://github.com/conda-forge/waybackpy-feedstock), maintainers are [@rafaelrdealmeida](https://github.com/rafaelrdealmeida/),
@ -48,27 +48,26 @@ See also [waybackpy feedstock](https://github.com/conda-forge/waybackpy-feedstoc
conda install -c conda-forge waybackpy conda install -c conda-forge waybackpy
``` ```
**Install directly from [this git repository](https://github.com/akamhy/waybackpy) (NOT recommended)**: **Install directly from [this git repository](https://github.com/akamhy/waybackpy) (NOT recommended)**:
```bash ```bash
pip install git+https://github.com/akamhy/waybackpy.git pip install git+https://github.com/akamhy/waybackpy.git
``` ```
## 🐳 Docker Image
### 🐳 Docker Image
Docker Hub : <https://hub.docker.com/r/secsi/waybackpy> Docker Hub : <https://hub.docker.com/r/secsi/waybackpy>
[Docker image](https://searchitoperations.techtarget.com/definition/Docker-image) is automatically updated on every release by [Regulary and Automatically Updated Docker Images](https://github.com/cybersecsi/RAUDI) (RAUDI). [Docker image](https://searchitoperations.techtarget.com/definition/Docker-image) is automatically updated on every release by [Regulary and Automatically Updated Docker Images](https://github.com/cybersecsi/RAUDI) (RAUDI).
RAUDI is a tool by SecSI (<https://secsi.io>), an Italian cybersecurity startup. RAUDI is a tool by SecSI (<https://secsi.io>), an Italian cybersecurity startup.
## 🚀 Usage
### 🚀 Usage ### As a Python package
#### As a Python package #### Save API aka SavePageNow
##### Save API aka SavePageNow
```python ```python
>>> from waybackpy import WaybackMachineSaveAPI >>> from waybackpy import WaybackMachineSaveAPI
>>> url = "https://github.com" >>> url = "https://github.com"
@ -83,7 +82,8 @@ False
datetime.datetime(2022, 1, 18, 12, 52, 49) datetime.datetime(2022, 1, 18, 12, 52, 49)
``` ```
##### Availability API #### Availability API
```python ```python
>>> from waybackpy import WaybackMachineAvailabilityAPI >>> from waybackpy import WaybackMachineAvailabilityAPI
>>> >>>
@ -102,7 +102,8 @@ https://web.archive.org/web/20220118150444/https://www.google.com/
https://web.archive.org/web/20101010101708/http://www.google.com/ https://web.archive.org/web/20101010101708/http://www.google.com/
``` ```
##### CDX API aka CDXServerAPI #### CDX API aka CDXServerAPI
```python ```python
>>> from waybackpy import WaybackMachineCDXServerAPI >>> from waybackpy import WaybackMachineCDXServerAPI
>>> url = "https://pypi.org" >>> url = "https://pypi.org"
@ -122,8 +123,7 @@ https://web.archive.org/web/20171206002737/http://pypi.org:80/
> Documentation is at <https://github.com/akamhy/waybackpy/wiki/Python-package-docs>. > Documentation is at <https://github.com/akamhy/waybackpy/wiki/Python-package-docs>.
### As a CLI tool
#### As a CLI tool
Demo video on [asciinema.org](https://asciinema.org), you can copy the text from video: Demo video on [asciinema.org](https://asciinema.org), you can copy the text from video:
@ -131,7 +131,8 @@ Demo video on [asciinema.org](https://asciinema.org), you can copy the text from
> CLI documentation is at <https://github.com/akamhy/waybackpy/wiki/CLI-docs>. > CLI documentation is at <https://github.com/akamhy/waybackpy/wiki/CLI-docs>.
### 🛡 License ## 🛡 License
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://github.com/akamhy/waybackpy/blob/master/LICENSE) [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://github.com/akamhy/waybackpy/blob/master/LICENSE)
Copyright (c) 2020-2022 Akash Mahanty Et al. Copyright (c) 2020-2022 Akash Mahanty Et al.

8
snapcraft.yaml
View File

@ -1,10 +1,10 @@
name: waybackpy name: waybackpy
summary: Wayback Machine API interface and a command-line tool summary: Wayback Machine API interface and a command-line tool
description: | description: |
Waybackpy is a CLI tool that interfaces with the Wayback Machine APIs. Waybackpy is a CLI tool that interfaces with the Wayback Machine APIs.
Wayback Machine has three client side public APIs, Save API, Wayback Machine has three client side public APIs, Save API,
Availability API and CDX API. These three APIs can be accessed via Availability API and CDX API. These three APIs can be accessed via
the waybackpy from the terminal. the waybackpy from the terminal.
version: git version: git
grade: stable grade: stable
confinement: strict confinement: strict