| Name | audit-ninja JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | This is a auditing tool for Django Applications |
| upload_time | 2024-08-21 08:36:00 |
| maintainer | None |
| docs_url | None |
| author | Anand Singh |
| requires_python | None |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Audit Ninja
## Overview
Audit Ninja is a middleware package designed to provide comprehensive auditing for your Django applications. It monitors and records changes across network data and Django models, ensuring that all relevant information, such as IP addresses and user details, is logged and stored securely.
## Features
- **Network Data Monitoring**: Tracks network data including IP addresses and user details.
- **Model Change Detection**: Automatically checks for any changes in the Django models where the package is imported.
- **Authorization Checks**: Ensures that all actions are authorized before recording them.
- **Data Storage**: Stores all audit data in a MongoDB database. Requires credentials for the Django database instance.
## Installation
To install Audit Ninja, use `pip`:
```bash
pip install audit_ninja
```
## Configuration
- **Django Settings**: Add the middleware to your MIDDLEWARE setting in settings.py:
```python
MIDDLEWARE = [
# other middleware
'audit_ninja.middleware.AuditMiddleware',
]
```
- **MongoDB Settings**: Configure the MongoDB connection in your settings.py:
```python
AUDIT_MONGO_DB = {
'host': 'your-mongodb-host',
'port': 27017,
'db_name': 'your-database-name',
'user': 'your-username',
'password': 'your-password',
}
```
- **Database Credentials**: Ensure that the package has access to the Django database credentials for authorization checks.
## Usage
Once installed and configured, Audit Ninja will automatically start monitoring network data and changes in your Django models. You can customize the behavior by adjusting the settings in your settings.py file.
## Contributing
## Contributing
Contributions are welcome! To contribute to this project, please follow these steps:
1. **Fork the repository**: Click on the "Fork" button at the top-right corner of the repository page on GitHub to create a copy of the repository under your own GitHub account.
2. **Create a new branch**: Switch to your forked repository and create a new branch for your changes. This keeps your work separate from the main codebase. You can create a new branch using the following command:
```bash
git checkout -b your-branch-name
```
3. **Make your changes**: Make the necessary changes or additions to the codebase on your new branch.
4. **Submit a pull request**: Once your changes are ready, push your branch to your forked repository and navigate to the original repository on GitHub. Click on the “Pull Requests” tab, then click on the “New Pull Request” button. Follow the instructions to submit your pull request for review.
## License
Audit Ninja is licensed under the MIT License.
## Contact
For any issues or queries, please contact learning.with.anand@gmail.com.
Feel free to adjust any specific details or add more sections as needed!
Raw data
{
"_id": null,
"home_page": null,
"name": "audit-ninja",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Anand Singh",
"author_email": "anandi1990singh@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/30/33/95f463ded26e97df9d0ad27a8b2dd2c1b307cfcb1d0d835563a3bf88fd20/audit_ninja-0.1.1.tar.gz",
"platform": null,
"description": "# Audit Ninja\n\n## Overview\n\nAudit Ninja is a middleware package designed to provide comprehensive auditing for your Django applications. It monitors and records changes across network data and Django models, ensuring that all relevant information, such as IP addresses and user details, is logged and stored securely.\n\n## Features\n\n- **Network Data Monitoring**: Tracks network data including IP addresses and user details.\n- **Model Change Detection**: Automatically checks for any changes in the Django models where the package is imported.\n- **Authorization Checks**: Ensures that all actions are authorized before recording them.\n- **Data Storage**: Stores all audit data in a MongoDB database. Requires credentials for the Django database instance.\n\n## Installation\n\nTo install Audit Ninja, use `pip`:\n\n```bash\npip install audit_ninja\n```\n\n## Configuration\n\n- **Django Settings**: Add the middleware to your MIDDLEWARE setting in settings.py:\n```python\nMIDDLEWARE = [\n # other middleware\n 'audit_ninja.middleware.AuditMiddleware',\n]\n```\n- **MongoDB Settings**: Configure the MongoDB connection in your settings.py:\n```python\nAUDIT_MONGO_DB = {\n 'host': 'your-mongodb-host',\n 'port': 27017,\n 'db_name': 'your-database-name',\n 'user': 'your-username',\n 'password': 'your-password',\n}\n```\n- **Database Credentials**: Ensure that the package has access to the Django database credentials for authorization checks.\n\n## Usage\nOnce installed and configured, Audit Ninja will automatically start monitoring network data and changes in your Django models. You can customize the behavior by adjusting the settings in your settings.py file.\n\n## Contributing\n\n## Contributing\n\nContributions are welcome! To contribute to this project, please follow these steps:\n\n1. **Fork the repository**: Click on the \"Fork\" button at the top-right corner of the repository page on GitHub to create a copy of the repository under your own GitHub account.\n\n2. **Create a new branch**: Switch to your forked repository and create a new branch for your changes. This keeps your work separate from the main codebase. You can create a new branch using the following command:\n\n ```bash\n git checkout -b your-branch-name\n ```\n3. **Make your changes**: Make the necessary changes or additions to the codebase on your new branch.\n4. **Submit a pull request**: Once your changes are ready, push your branch to your forked repository and navigate to the original repository on GitHub. Click on the \u201cPull Requests\u201d tab, then click on the \u201cNew Pull Request\u201d button. Follow the instructions to submit your pull request for review.\n\n\n## License\n\nAudit Ninja is licensed under the MIT License.\n\n## Contact\n\nFor any issues or queries, please contact learning.with.anand@gmail.com.\nFeel free to adjust any specific details or add more sections as needed!\n",
"bugtrack_url": null,
"license": null,
"summary": "This is a auditing tool for Django Applications",
"version": "0.1.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "303395f463ded26e97df9d0ad27a8b2dd2c1b307cfcb1d0d835563a3bf88fd20",
"md5": "93d7c2be10ea3230ec426a48ea06ebc9",
"sha256": "8e08c73cd630de732f8a5bef15b40a9cce5aa9b6cbfb2cf9d3d28dc8a8521fc1"
},
"downloads": -1,
"filename": "audit_ninja-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "93d7c2be10ea3230ec426a48ea06ebc9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 15633,
"upload_time": "2024-08-21T08:36:00",
"upload_time_iso_8601": "2024-08-21T08:36:00.004461Z",
"url": "https://files.pythonhosted.org/packages/30/33/95f463ded26e97df9d0ad27a8b2dd2c1b307cfcb1d0d835563a3bf88fd20/audit_ninja-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-21 08:36:00",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "audit-ninja"
}
