Release Date: June 19, 2024
We are excited to announce the initial release of `nambazasimu`, a Python package designed to identify Tanzanian phone number carriers. This release includes the core functionality and comprehensive documentation to help users get started quickly.
New Features
- **Carrier Identification**: Determine the carrier (Airtel, Voda, Tigo, Halotel, Zantel, Smile or TTCL) of a Tanzanian phone number.
python
from nambazasimu.carrier_identifier import identify_carrier
print(identify_carrier("+255684567890")) Output: Airtel
print(identify_carrier("255754567890")) Output: Voda
print(identify_carrier("0714567890")) Output: Tigo
Documentation
- **Comprehensive README**: Detailed instructions on how to install, use, and contribute to the package.
- **Installation Guide**: Step-by-step instructions to install `nambazasimu` using pip.
- **Usage Examples**: Code snippets demonstrating how to use the core functionality of the package.
- **Contribution Guidelines**: Information on how to fork the repository, make changes, and submit a pull request.
- **References**: Links to useful resources such as the Wikipedia article on Tanzanian phone numbers and a Jamii Forums thread discussing carrier identification.
How to Install
To install `nambazasimu`, use pip:
bash
pip install nambazasimu
How to Use
To identify the carrier of a Tanzanian phone number, import the `identify_carrier` function and pass the phone number as an argument:
python
from nambazasimu.carrier_identifier import identify_carrier
print(identify_carrier("+255684567890")) Output: Airtel
How to Contribute
We welcome contributions! Please follow these steps to contribute:
1. **Fork the repo**: Click the "Fork" button at the top right of the repository page.
2. **Clone the forked repo**:
bash
git clone https://github.com/yourusername/nambazasimu.git
3. **Navigate to the project directory**:
bash
cd nambazasimu
4. **Set up a Python environment** and install the requirements:
bash
python -m venv venv
source venv/bin/activate On Windows use `venv\Scripts\activate`
pip install -r requirements.txt
5. **Make your changes**, and be sure to write tests if necessary.
6. **Commit your changes**:
bash
git add .
git commit -m "Description of your changes"
7. **Push your changes to your fork**:
bash
git push origin your-branch-name
8. **Raise a Pull Request**: Go to the original repository and create a new pull request.
Issues and Feedback
If you encounter any issues or have feedback, please report them via the [GitHub issues page](https://github.com/genie360s/nambazasimu/issues). Provide as much detail as possible about the issue, including any error messages and steps to reproduce the problem.
---
References
- [Wikipedia article on Tanzanian phone numbers](https://sw.wikipedia.org/wiki/Namba_za_simu_Tanzania)
- [Jamii Forums thread on identifying phone numbers by network](https://www.jamiiforums.com/threads/jinsi-ya-kutambua-namba-ya-simu-ni-ya-mtandao-upi.1438096/)
---