Skip to main content

A python package for connecting with database.

Project description

MongoDB Automation Suite

This project presents a groundbreaking approach to automating MongoDB database operations, integrating seamlessly with CI/CD workflows. It's designed specifically for file-based database management, offering a robust suite for deploying and retrieving databases with MongoDB Atlas.

Key Features 🌟

  • Automated database operations.
  • Simple CI/CD integration.
  • Direct deployment to MongoDB Atlas.

Installation 🛠️

Install the mymongoo-automate library using pip:

pip install mymongoo-automate==0.0.4

Usage Instructions 📘

Setting Up

Import the mongo_crud module from the library:

python

from database_automation import mongo_crud print("Library Imported Successfully")

Configuration

Set up your MongoDB Atlas client URL, database, and collection name:

client_url = "<your_mongodb_atlas_client_url>"
database = "<your_database_name>"
collection_name = "<your_collection_name>"

Example Operation 📖

Store a record:

mg = mongo_crud.mongo_operation(client_url, database, collection_name)
mg.insert_record({"Name": "Ashutosh", "Designation": "AI Engineer", "Salary": "100k"}, collection_name)
print("Data Stored")

Get Involved 🤝

Contributions are welcome! Feel free to submit issues or pull requests. For queries, contact us at [ashutosh.formin@gmail.com ].

requirements_dev.txt:

Streamlining Testing and Development This file simplifies the installation and management of dependencies specifically needed for development and testing. It keeps these dependencies separate from the production environment, ensuring a more organized and efficient workflow.

Understanding requirements_dev.txt vs. requirements.txt

While requirements.txt defines dependencies essential for running the production code of our Python project, requirements_dev.txt caters to the dependencies necessary for development and testing. This distinction ensures efficient dependency management across different project stages.

tox.ini: Versatile Python Testing

tox.ini is crucial for testing our Python package across various Python versions.

How Tox Environments Operate

Tox environments function through:

  1. Installing necessary dependencies and packages.
  2. Executing defined commands.
  3. Integrating features of virtualenvwrapper and makefile.
  4. Generating a .tox directory for environment management.

pyproject.toml

it is being used for configuration the python project it is a alternative of the setup.cfg file. its containts configuration related to the build system such as the build tool used package name version author license and dependencies

setup.cfg: Configuring Package Installation

The setup.cfg file is utilized by setuptools for configuring the packaging and installation processes of our Python project. This file plays a pivotal role in defining how the project is packaged and distributed.

Testing Python Application: Ensuring Quality and Reliability

Our approach to testing is comprehensive, encompassing various types and modes to guarantee the highest quality.

Types of Testing:

  1. Automated Testing: Streamlining test execution.
  2. Manual Testing: Personal inspection and evaluation.

Modes of Testing:

  1. Unit Testing: Verifying individual components.
  2. Integration Testing: Ensuring combined components work harmoniously.

Preferred Testing Frameworks:

  1. pytest: For powerful and simple tests.
  2. unittest: Standard unit testing framework.
  3. robotframework: For acceptance testing and automation.
  4. selenium: Specialized in web application testing.
  5. behave: For behavior-driven development.
  6. doctest: Embedding tests in documentation.

Adhering to Coding Standards: Style Formatting and Syntax

Maintaining a high standard of code quality is crucial. We ensure this through the use of:

  1. pylint: Analyzing code for potential errors.
  2. flake8: A comprehensive tool combining pylint, pycodestyle, and mccabe for robust syntax checking.
  3. pycodestyle: Enforcing Python style conventions.

=======

requirements_dev.txt:

Streamlining Testing and Development This file simplifies the installation and management of dependencies specifically needed for development and testing. It keeps these dependencies separate from the production environment, ensuring a more organized and efficient workflow.

Understanding requirements_dev.txt vs. requirements.txt

While requirements.txt defines dependencies essential for running the production code of our Python project, requirements_dev.txt caters to the dependencies necessary for development and testing. This distinction ensures efficient dependency management across different project stages.

tox.ini: Versatile Python Testing

tox.ini is crucial for testing our Python package across various Python versions.

How Tox Environments Operate

Tox environments function through:

  1. Installing necessary dependencies and packages.
  2. Executing defined commands.
  3. Integrating features of virtualenvwrapper and makefile.
  4. Generating a .tox directory for environment management.

pyproject.toml

it is being used for configuration the python project it is a alternative of the setup.cfg file. its containts configuration related to the build system such as the build tool used package name version author license and dependencies

setup.cfg: Configuring Package Installation

The setup.cfg file is utilized by setuptools for configuring the packaging and installation processes of our Python project. This file plays a pivotal role in defining how the project is packaged and distributed.

Testing Python Application: Ensuring Quality and Reliability

Our approach to testing is comprehensive, encompassing various types and modes to guarantee the highest quality.

Types of Testing:

  1. Automated Testing: Streamlining test execution.
  2. Manual Testing: Personal inspection and evaluation.

Modes of Testing:

  1. Unit Testing: Verifying individual components.
  2. Integration Testing: Ensuring combined components work harmoniously.

Preferred Testing Frameworks:

  1. pytest: For powerful and simple tests.
  2. unittest: Standard unit testing framework.
  3. robotframework: For acceptance testing and automation.
  4. selenium: Specialized in web application testing.
  5. behave: For behavior-driven development.
  6. doctest: Embedding tests in documentation.

Adhering to Coding Standards: Style Formatting and Syntax

Maintaining a high standard of code quality is crucial. We ensure this through the use of:

  1. pylint: Analyzing code for potential errors.
  2. flake8: A comprehensive tool combining pylint, pycodestyle, and mccabe for robust syntax checking.
  3. pycodestyle: Enforcing Python style conventions

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mymongoo-automate-0.0.5.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mymongoo_automate-0.0.5-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

Details for the file mymongoo-automate-0.0.5.tar.gz.

File metadata

  • Download URL: mymongoo-automate-0.0.5.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for mymongoo-automate-0.0.5.tar.gz
Algorithm Hash digest
SHA256 10aae587c32f2aa1527ae9048974c07656e020bcae8d6b5db0ea379a1433c39d
MD5 9e52d4887fe7aa6f7c3169429c0e18e0
BLAKE2b-256 78ae434c144572ce7f573c3ab12ffde7b76d60edfd551cdd819f5e6bea23ed9f

See more details on using hashes here.

File details

Details for the file mymongoo_automate-0.0.5-py3-none-any.whl.

File metadata

File hashes

Hashes for mymongoo_automate-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 50cfe7a040091a30e228a6bfb562575134ea458f9bbcd521bf7c454d0a2bfb89
MD5 aa3bc816c14f8c8746119c94e9a5be8e
BLAKE2b-256 708a1d7345521405f27b5365e8cc265fef0eb82c8542ec27db78706d5956ffe1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page