Document (#2)

* doc : README.md updated

* fix : setup.py updated

* fix : codecov action updated

* fix : __init__.py modified

* doc : discord badge removed

* doc : codecov badge added

* fix : minor edit in setup.py

* fix : minor edit in setup.py

Author: sepandhaghighi

.github/ISSUE_TEMPLATE/config.yml

@@ -1,8 +1,5 @@
 blank_issues_enabled: false
 contact_links:
-  - name: Discord
-    url: https://discord.gg/TODO
-    about: Ask questions and discuss with other IPForce community members 
   - name: Website
     url: https://openscilab.com/
     about: Check out our website for more information

.github/workflows/test.yml

@@ -46,7 +46,8 @@ jobs:
     - name: Upload coverage to Codecov
       uses: codecov/codecov-action@v4
       with:
-        fail_ci_if_error: false
+        fail_ci_if_error: true
+        token: ${{ secrets.CODECOV_TOKEN }}
       if: matrix.python-version == env.TEST_PYTHON_VERSION && matrix.os == env.TEST_OS
     - name: Version check
       run: |

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 OpenSciLab
+Copyright (c) 2026 OpenSciLab
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,11 +1,10 @@
 <div align="center">
-<img src="https://github.com/openscilab/ipforce/raw/main/otherfiles/logo.png" width="350">
-<h1>IPForce: TODO</h1>
+<h1>IPForce: Force IPv4/IPv6 in Python HTTP Requests</h1>
 <br/>
 <a href="https://badge.fury.io/py/ipforce"><img src="https://badge.fury.io/py/ipforce.svg" alt="PyPI version"></a>
 <a href="https://www.python.org/"><img src="https://img.shields.io/badge/built%20with-Python3-green.svg" alt="built with Python3"></a>
 <a href="https://github.com/openscilab/ipforce"><img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/openscilab/ipforce"></a>
-<a href="https://discord.gg/TODO"><img src="https://img.shields.io/discord/TODO" alt="Discord Channel"></a>
+<a href="https://codecov.io/gh/openscilab/ipforce"><img src="https://codecov.io/gh/openscilab/ipforce/graph/badge.svg?token=8EJBSMPZF1"></a>
 </div>			
 				
 ## Overview
@@ -102,11 +101,6 @@ Just fill an issue and describe it. We'll check it ASAP!
 
 - Please complete the issue template
 
-You can also join our discord server
-
-<a href="https://discord.gg/TODO">
-  <img src="https://img.shields.io/discord/TODO.svg?style=for-the-badge" alt="Discord Channel">
-</a>
 
 ## Show Your Support
 								

ipforce/__init__.py

@@ -4,3 +4,5 @@
 from .adapters import IPv4TransportAdapter, IPv6TransportAdapter
 
 __version__ = IPFORCE_VERSION
+
+__all__ = ["IPv4TransportAdapter", "IPv6TransportAdapter"]

setup.py

@@ -24,22 +24,24 @@ def read_description() -> str:
             description += c.read()
         return description
     except Exception:
-        return '''TODO'''
+        return '''IPForce is a Python library that provides HTTP adapters for forcing specific IP protocol versions (IPv4 or IPv6) during HTTP requests.
+                It's particularly useful for testing network connectivity, ensuring compatibility with specific network configurations,
+                and controlling which IP protocol version is used for DNS resolution and connections.'''
 
 
 setup(
     name='ipforce',
     packages=['ipforce'],
     version='0.1',
-    description='TODO',
+    description='IPForce: Force IPv4/IPv6 in Python HTTP Requests',
     long_description=read_description(),
     long_description_content_type='text/markdown',
     include_package_data=True,
     author='IPForce Development Team',
     author_email='ipforce@openscilab.com',
     url='https://github.com/openscilab/ipforce',
     download_url='https://github.com/openscilab/ipforce/tarball/v0.1',
-    keywords="ip ipv4 adapter",
+    keywords="http ipv4 ipv6 network requests adapter dns socket protocol ip-force",
     project_urls={
         'Source': 'https://github.com/openscilab/ipforce'
     },
@@ -57,11 +59,13 @@ def read_description() -> str:
         'Programming Language :: Python :: 3.11',
         'Programming Language :: Python :: 3.12',
         'Programming Language :: Python :: 3.13',
+        'Programming Language :: Python :: 3.14',
         'Intended Audience :: Developers',
         'Intended Audience :: Education',
-        'Intended Audience :: End Users/Desktop',
         'Topic :: System :: Networking',
         'Topic :: Utilities',
+        'Topic :: Internet :: WWW/HTTP',
+        'Topic :: Software Development :: Libraries :: Python Modules',
     ],
     license='MIT',
 )