A comprehensive Python package for managing Nepali public entities with optional API and scraping capabilities.
For Jawafdehi team members and interns: This service is part of the Jawafdehi meta-repository, which provides documentation, specs, and shared resources across the Jawafdehi product family. Working from the meta repo setup is strongly encouraged for rich AI-powered development context.
For open source contributors: NES is our primary open source target! You can contribute directly to this repository by cloning it and submitting a PR. The meta repo is optional for external contributors - just fork this repo, make your changes, and submit a pull request.
For Jawafdehi team members and interns: This service is part of the Jawafdehi meta-repository, which provides documentation, specs, and shared resources. Working from the meta repo setup is strongly encouraged for rich AI-powered development context.
For open source contributors: NES is our primary open source target! You can contribute directly to this repository by cloning it and submitting a PR. The meta repo is optional for external contributors - just fork this repo, make your changes, and submit a pull request.
# Install the package
pip install nepal-entity-service[all]
# Configure database path
cp .env.example .env
# Edit .env and set NES_DB_URL
# Start the API server
poetry run nes-apiFor detailed documentation including installation, database setup, and usage guides, see:
- Online: nes.newnepal.org
- Local: Browse the
docs/folder in this repository
- Core: Entity and relationship management with version history
- API: FastAPI web service with entity management endpoints
- Scraping: ML-powered scraping tools for building entity databases
- Migrations: Database migration system for schema evolution
When working with this Nepal Entity Service, please use Nepali local names and references in examples, documentation, and code samples whenever available. This includes:
- Person names: Use authentic Nepali names (e.g., "Harka Sampang", "Rabindra Mishra", "Miraj Dhungana")
- Organization names: Use actual Nepali organizations (e.g., "People First Party", "Jaya Matribhumi Party", "Jan Adhikaar Party")
- Location references: Use Nepali places and administrative divisions
- Cultural context: Maintain authenticity to Nepali political, social, and organizational structures
This approach ensures the service remains contextually relevant to its intended use case of managing Nepali public entities.
We welcome contributions! Please see our Contributor Guide and Design Patterns for guidelines on code style, testing, and development workflow.
This project is licensed under the Hippocratic License 3.0 - an ethical source license that permits use, modification, and distribution for any purpose that does not violate human rights principles as defined by the United Nations Universal Declaration of Human Rights.
See the LICENSE file for the complete license text, or visit firstdonoharm.dev to learn more about the Hippocratic License.