diff --git a/.github/images/accountant.png b/.github/images/accountant.png deleted file mode 100644 index af00189..0000000 Binary files a/.github/images/accountant.png and /dev/null differ diff --git a/.github/images/banner.png b/.github/images/banner.png index 806fbf4..1a1bbd8 100644 Binary files a/.github/images/banner.png and b/.github/images/banner.png differ diff --git a/.github/images/jigsaw.png b/.github/images/jigsaw.png deleted file mode 100644 index 76b3979..0000000 Binary files a/.github/images/jigsaw.png and /dev/null differ diff --git a/.github/images/mapping.png b/.github/images/mapping.png deleted file mode 100644 index 0095821..0000000 Binary files a/.github/images/mapping.png and /dev/null differ diff --git a/.github/images/networking.png b/.github/images/networking.png deleted file mode 100644 index e44e330..0000000 Binary files a/.github/images/networking.png and /dev/null differ diff --git a/.github/images/new b/.github/images/new deleted file mode 100644 index 8b13789..0000000 --- a/.github/images/new +++ /dev/null @@ -1 +0,0 @@ - diff --git a/.github/images/phone-call.png b/.github/images/phone-call.png deleted file mode 100644 index c31d2d0..0000000 Binary files a/.github/images/phone-call.png and /dev/null differ diff --git a/.github/images/planning.png b/.github/images/planning.png deleted file mode 100644 index ccd0a5a..0000000 Binary files a/.github/images/planning.png and /dev/null differ diff --git a/.github/images/woman.png b/.github/images/woman.png deleted file mode 100644 index be6ac95..0000000 Binary files a/.github/images/woman.png and /dev/null differ diff --git a/README.md b/README.md index c75a430..7acda17 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@
- PySIP: Python SIP Library for Custom VoIP Solutions + Python SIP Library for Custom VoIP Solutions
**PySIP** is an asynchronous Python library designed to simplify working with the Session Initiation Protocol (SIP) for VoIP communication. Whether you're building automated call systems, interactive voice response (IVR) menus, or any SIP-based application, PySIP gives you the flexibility to create and manage SIP accounts, handle calls, and implement custom logic with ease. @@ -11,14 +11,10 @@Feature | Description | |
---|---|---|
- - | Complete SIP Account Management | @@ -27,9 +23,6 @@|
- - | Custom Call Flows | @@ -38,9 +31,6 @@|
- - | UDP Transport Layer | @@ -49,9 +39,6 @@|
- - | Flexible Call Handling | @@ -60,9 +47,6 @@|
- - | Fully Extensible | @@ -93,7 +77,7 @@ ### Step 1: Clone the repository ```bash -git clone https://github.com/yourusername/PySIP.git +git clone https://github.com/moha-abdi/PySIP.git cd PySIP ``` @@ -185,19 +169,19 @@ The `SipAccount` class is at the core of PySIP. It handles all account-related t account = SipAccount(username, password, server) ``` -#### **Registering**: +#### **Registering**: Call the `register()` method to register the SIP account with the server: ```python await account.register() ``` -#### **Making Calls**: +#### **Making Calls**: The `make_call(destination)` method initiates a call to the destination number: ```python call = account.make_call("destination_number") ``` -#### **Unregistering**: +#### **Unregistering**: When you're done, unregister the account to gracefully close the session: ```python await account.unregister() @@ -215,13 +199,13 @@ The `CallHandler` is responsible for handling the call flow. It allows you to sa await call_handler.say("Welcome to our service.") ``` -#### **Gathering user input**: -Use `gather_and_say()` to gather input from the user, such as pressing a digit: +#### **Gathering user input**: +Use `gather()` to gather input from the user, such as pressing a digit: ```python -option = await call_handler.gather_and_say(length=1, delay=5) +dtmf_key = await call_handler.gather(length=1, timeout=5) ``` -#### **Transferring the call**: +#### **Transferring the call**: You can forward the call to another number: ```python await call_handler.transfer_to("1234567890") @@ -234,13 +218,13 @@ await call_handler.transfer_to("1234567890") The `UdpHandler` is an internal module that manages the asynchronous sending and receiving of SIP messages over the network. -#### **Sending a message**: +#### **Sending a message**: The `send_message()` method sends a UDP message to the SIP server or peer: ```python self.transport.sendto(message) ``` -#### **Receiving a datagram**: +#### **Receiving a datagram**: The `datagram_received()` method handles incoming messages, placing them in a queue for processing: ```python self.data_q.put_nowait(data) @@ -311,6 +295,6 @@ Contributions are welcome! If you would like to contribute to the development of --- -