Skip to content

Commit 175d9f0

Browse files
Improve documentation
1 parent 0363c0e commit 175d9f0

File tree

3 files changed

+32
-8
lines changed

3 files changed

+32
-8
lines changed

README.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# asyncio-https-proxy
22

3-
# --8<-- [start:intro]
4-
53
An embeddable, asyncio-based HTTPS forward proxy server with built-in request and response interception capabilities. Designed to be integrated directly into your Python applications rather than run as a standalone service.
64

75
It's designed to be a lightweight, flexible solution for developers needing to proxy HTTP and HTTPS traffic within their applications, with full support for SSL/TLS interception. Developer keep control over the outgoing requests and responses allowing to use custom logic for modifying, logging, blocking traffic and even custom TLS fingerprinting.
@@ -31,9 +29,7 @@ It's a fundation layer for building your own proxy-based tools.
3129
- Fault injection and network simulation
3230
- Research and educational purposes
3331

34-
# --8<-- [end:intro]
35-
3632

3733
## Documentation
3834

39-
Document is available herehttps://asyncio-https-proxy.readthedocs.io/en/latest/
35+
Document is available here: https://asyncio-https-proxy.readthedocs.io/en/latest/

docs/index.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,31 @@
11
# asyncio-https-proxy
22

3-
--8<-- "README.md:intro"
3+
An embeddable, asyncio-based HTTPS forward proxy server with built-in request and response interception capabilities. Designed to be integrated directly into your Python applications rather than run as a standalone service.
4+
5+
It's designed to be a lightweight, flexible solution for developers needing to proxy HTTP and HTTPS traffic within their applications, with full support for SSL/TLS interception. Developer keep control over the outgoing requests and responses allowing to use custom logic for modifying, logging, blocking traffic and even custom TLS fingerprinting.
6+
7+
The library is built using Python's asyncio framework, making it suitable for high-performance, asynchronous applications.
8+
9+
The library manages its own Certificate Authority (CA) to dynamically generate and sign certificates for intercepted HTTPS traffic.
10+
11+
It's a fundation layer for building your own proxy-based tools.
12+
13+
## Features
14+
15+
- **Embeddable**: Integrate proxy functionality directly into your Python application
16+
- **Asyncio-native**: Built with Python's asyncio for seamless integration with async applications
17+
- **HTTPS/SSL support**: Full SSL/TLS interception
18+
- **Certificate generation**: Dynamically generate and sign certificates for intercepted HTTPS traffic
19+
- **Request/Response interception**: Modify, log, or block HTTP(S) traffic in real-time
20+
- **Lightweight**: Pure Python implementation with only cryptography as a direct external dependency
21+
22+
## Use Cases
23+
24+
- Web scraping frameworks with request modification and custom TLS fingerprinting support
25+
- Testing frameworks with traffic interception
26+
- Security tools and traffic analysis
27+
- Development tools requiring HTTP(S) proxying
28+
- Custom cache or logging solutions
29+
- Fault injection and network simulation
30+
- Research and educational purposes
31+

mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ theme:
3030
nav:
3131
- Home: index.md
3232
- Getting Started: getting-started.md
33-
- Custom CA: custom-ca.md
33+
- How to:
34+
- Custom CA: custom-ca.md
3435
- API Reference: reference/index.md
3536
- Development: development.md
3637
- FAQ: faq.md
@@ -67,7 +68,6 @@ markdown_extensions:
6768
line_spans: __span
6869
pygments_lang_class: true
6970
- pymdownx.inlinehilite
70-
- pymdownx.snippets
7171
- pymdownx.tabbed:
7272
alternate_style: true
7373
- attr_list

0 commit comments

Comments
 (0)