chore: docs

Author: thewebscraping

README.md

@@ -57,10 +57,10 @@ it combines ease of use with advanced functionality for secure networking.
 
 Modern websites increasingly use **TLS Fingerprinting** and anti-bot tools like Cloudflare Bot Fight Mode to block web crawlers.
 
-**TLS Requests** bypasses these obstacles by mimicking browser-like TLS behaviors,
+**TLS Requests** bypass these obstacles by mimicking browser-like TLS behaviors,
 making it easy to scrape data or interact with websites that use sophisticated anti-bot measures.
 
-### Example: Unlocking Cloudflare Bot Fight Mode
+### Unlocking Cloudflare Bot Fight Mode
 ![coingecko.png](https://raw.githubusercontent.com/thewebscraping/tls-requests/refs/heads/main/docs/static/coingecko.png)
 
 **Example Code:**

docs/tls/index.md

@@ -2,6 +2,7 @@ TLS-Client Documentation
 ========================
 
 **Acknowledgment**
+
 Special thanks to [`bogdanfinn`](https://github.com/bogdanfinn/tls-client). For more details, visit the [GitHub repository](https://github.com/bogdanfinn/tls-client) or explore the [documentation](https://bogdanfinn.gitbook.io/open-source-oasis).
 
 ## Wrapper TLS Client
@@ -15,8 +16,6 @@ The TLSClient class is designed to be used as a singleton-like interface. Upon f
 >>> TLSClient.initialize()
 ```
 
-![load_library.png](../static/load_library.png)
-
 !!! note
     The first time you initialize the TLSClient class, it will automatically find and load the appropriate library for your machine.
 

docs/tls/install.md

@@ -1,23 +1,28 @@
 ## Auto Download
 
-No additional steps are required! Simply use the Python syntax below, and the library will automatically detect and download the version compatible with your operating system by fetching it from the GitHub repository.
-
-#### Reference: [GitHub Releases - TLS Client](https://github.com/bogdanfinn/tls-client/releases/)
-
-The downloaded library files are stored in the `tls_requests/bin` directory.
+This approach simplifies usage as it automatically detects your OS and downloads the appropriate version of the library. To use it:
 
 ```pycon
->>> from src import tls_requests
+>>> import tls_requests
 >>> r = tls_requests.get('https://httpbin.org/get')
 ```
 
-## Manual Download
+!!! note:
+    The library takes care of downloading necessary files and stores them in the `tls_requests/bin` directory.
 
-For manual installation, you can download the library using the following script:
+## Manual Download
 
-```python
-from tls_requests.models.libraries import TLSLibrary
+If you want more control, such as selecting a specific version of the library, you can use the manual method:
 
-TLSLibrary.load()
-# OR: TLSLibrary.download()
+```pycon
+>>> from tls_requests.models.libraries import TLSLibrary
+>>> TLSLibrary.download('1.7.10')
 ```
+
+This method is useful if you need to ensure compatibility with specific library versions.
+
+### Notes
+
+1.  **Dependencies**: Ensure Python is installed and configured correctly in your environment.
+2.  **Custom Directory**: If needed, the library’s downloaded binaries can be relocated manually to suit specific project structures.
+3.  **Reference**: [TLS Client GitHub Releases](https://github.com/bogdanfinn/tls-client/releases/) provides details about available versions and updates.

requirements.txt

@@ -1,3 +1,8 @@
+# Base
+chardet~=5.2.0
+requests~=2.32.3
+tqdm~=4.67.1
+
 # Documentation
 mkdocs==1.6.1
 mkautodoc==0.2.0

setup.cfg

@@ -4,6 +4,10 @@ long_description_content_type = text/markdown
 license = MIT
 license_file = LICENSE
 python_requires = >=3.9
+install_requires =
+    chardet ~= 5.2.0
+    requests ~= 2.32.3
+    tqdm ~= 4.67.1
 classifiers =
     Development Status :: 5 - Production/Stable
     Intended Audience :: Developers

tls_requests/__version__.py

@@ -3,5 +3,5 @@
 __url__ = "https://github.com/thewebscraping/tls-requests"
 __author__ = "Tu Pham"
 __author_email__ = "[email protected]"
-__version__ = "1.0.1"
+__version__ = "1.0.2"
 __license__ = "MIT"

tls_requests/models/libraries.py

@@ -94,14 +94,13 @@ def find_all(cls) -> list[str]:
         return glob.glob(os.path.join(BIN_DIR, r"*"))
 
     @classmethod
-    def download(cls) -> str:
+    def download(cls, version: str = None) -> str:
         try:
             download_url = None
-            for download_url in cls.fetch_api():
+            for download_url in cls.fetch_api(version):
                 if PATTERN_RE.search(download_url):
                     break
 
-            print(download_url)
             if download_url:
                 destination = os.path.join(BIN_DIR, download_url.split("/")[-1])
                 with requests.get(download_url, stream=True) as response:

tls_requests/models/response.py

@@ -207,16 +207,6 @@ def json(self, **kwargs: Any) -> Any:
     def __repr__(self) -> str:
         return f"<Response [{self.status_code}]>"
 
-    def __getstate__(self) -> dict[str, Any]:
-        return {
-            name: value
-            for name, value in self.__dict__.items()
-            if name not in ["stream", "is_closed"]
-        }
-
-    def __setstate__(self, state: dict[str, Any]) -> None:
-        pass
-
     def read(self) -> bytes:
         with self.stream as stream:
             self._content = b"".join(stream.render())

tls_requests/utils.py

@@ -40,21 +40,6 @@ def get_logger(
     return logger
 
 
-def primitive_value_to_str(value) -> str:
-    """
-    Coerce a primitive data type into a string value.
-
-    Note that we prefer JSON-style 'true'/'false' for boolean values here.
-    """
-    if value is True:
-        return "true"
-    elif value is False:
-        return "false"
-    elif value is None:
-        return ""
-    return str(value)
-
-
 def to_bytes(value: Any, encoding: str = "utf-8", *, lower: bool = False) -> bytes:
     if isinstance(value, (bytes, bytearray)):
         return value