updating first package

codeperfectplus · codeperfectplus · commit 7e5ce5fba6b1 · 2022-11-02T07:06:08.000+05:30
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at pycontributors@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,79 @@
+# Contributing to QuickDB
+
+We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
+
+- Reporting a bug
+- Discussing the current state of the code
+- Submitting a fix
+- Proposing new features
+- Becoming a maintainer
+
+## Steps to contribute
+
+- Comment on the issue you want to work on. Make sure it's not assigned to someone else.
+
+### Making a PR
+
+> - Make sure you have been assigned the issue to which you are making a PR.
+> - If you make PR before being assigned, It may be labeled `invalid` and closed without merging.
+
+- Fork the repo and clone it on your machine.
+- Add a upstream link to main branch in your cloned repo
+
+    ```sh
+    git remote add upstream https://github.com/py-contributors/quickdb.git
+    ```
+
+- Keep your cloned repo upto date by pulling from upstream (this will also avoid any merge conflicts while committing new changes)
+
+    ```sh
+    git pull upstream master
+    ```
+
+- Create your feature branch
+
+    ```sh
+    git checkout -b <feature-name>
+    ```
+
+- Commit all the changes
+
+    ```sh
+    git commit -am "Meaningful commit message"
+    ```
+
+- Push the changes for review
+
+    ```sh
+    git push origin <branch-name>
+    ```
+
+- Create a PR from our repo on Github.
+
+### Additional Notes
+
+- Any changes should be made in the `dev` branch.
+- Changes should be logged in the `CHANGELOG.md` file.
+- Code should be properly commented to ensure it's readability.
+- If you've added code that should be tested, add tests as comments.
+- Make sure your code properly formatted.
+- Issue that pull request!
+
+## Issue suggestions/Bug reporting
+
+When you are creating an issue, make sure it's not already present. Furthermore, provide a proper description of the changes. If you are suggesting any code improvements, provide through details about the improvements.
+
+**Great Issue suggestions** tend to have:
+
+- A quick summary of the changes.
+- In case of any bug provide steps to reproduce
+  - Be specific!
+  - Give sample code if you can.
+  - What you expected would happen
+  - What actually happens
+  - Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
+
+
+## License
+
+By contributing, you agree that your contributions will be licensed under its  [MIT License](http://choosealicense.com/licenses/mit/).
diff --git a/README.md b/README.md
@@ -1,9 +1,9 @@
-# python-db
+<h1 align="center"><a href="https://pypi.org/project/quickDatabase/">Quick DB ⚡ 0.0.1</a></h1>
 
+<p align="center">
 Light weight database for python, with a simple API and a simple file format.
 it is not meant to be a full featured database, but rather a simple way to  store data in a file.
-it's written in python, and is compatible with python 3.6 and above.
-
+it's written in python, and is compatible with python 3.6 and above.</p>
 
 ## Features
 
@@ -13,19 +13,43 @@ it's written in python, and is compatible with python 3.6 and above.
 * CLI interface
 * Open source
 
-## Documentation
+## Documentation/Tutorial
 
-The documentation is available at [not yet available]()
+The documentation is available at [Quick DB]](https://quickdb.readthedocs.io/en/latest/)
 
 ## Installation
 
-You can install python-db using pip:
-
-    pip install python-db
+You can install the package using pip:
 
+```bash
+pip install quickdatabase
+```
 
 ## Usage
 
-To use python-db, you need to import it:
+To use QuickDB, you need to import it:
+
+```bash
+from quickdb import QuickDB
+```
+
+## CONTRIBUTING
+
+If you want to contribute to this project, you can do so by forking the repository and making a pull request.
+Check out the [CONTRIBUTING.md](/CONTRIBUTING.md) file for more information.
+
+## LICENSE
+
+This project is licensed under the MIT License - see the [LICENSE](/LICENSE) file for details
+
+## COntributors
+
+<a href="https://github.com/Py-Contributors/quickdb/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=Py-Contributors/quickdb"/>
+</a>
+
+## Author
 
-    from python_db import Database
+- Module : QuickDB
+- Author  : py-contributors
+- Email   : pycontributors@gmail.com
diff --git a/quickdb_/main.py b/quickdb_/main.py
@@ -4,18 +4,19 @@
 from colorama import Fore, Style
 
 
-def print_it(color, text):
-    if color == "red":
-        print(Fore.RED + text + Style.RESET_ALL)
-    elif color == "green":
-        print(Fore.GREEN + text + Style.RESET_ALL)
-    elif color == 'blue':
-        print(Fore.BLUE + text + Style.RESET_ALL)
+def print_it(color, text, print_it=True):
+    if print_it:
+        if color == "red":
+            print(Fore.RED + text + Style.RESET_ALL)
+        elif color == "green":
+            print(Fore.GREEN + text + Style.RESET_ALL)
+        elif color == 'blue':
+            print(Fore.BLUE + text + Style.RESET_ALL)
 
 
 class QuickDB(object):
     """  python database.py """
-    def __init__(self, db_path, overwrite_db=False):
+    def __init__(self, db_path, overwrite_db=False, print_it=True):
         self.db_path = db_path
         self.db = self.__init_db(overwrite_db)
 
diff --git a/setup.py b/setup.py
@@ -4,7 +4,7 @@
     long_description = fh.read()
 
 setuptools.setup(
-    name="quickDB",
+    name="quickDatabase",
     version="0.0.1",
     author="Deepak Raj",
     author_email="deepak008@live.com",
diff --git a/test.sh b/test.sh
@@ -0,0 +1,31 @@
+#!/bin/bash
+if ! [ -x "$(command -v flake8)" ]; then
+    echo 'Error: flake8 is not installed.' >&2
+    echo 'Installing flake8...'
+    pip install flake8
+fi
+
+if ! [ -x "$(command -v twine)" ]; then
+    echo 'Error: twine is not installed.' >&2
+    echo 'Installing twine...'
+    pip install twine
+fi
+
+if ! [ -f "setup.py" ]; then
+  echo 'Error: setup.py is not found.' >&2
+  exit 1
+fi
+
+python3 setup.py bdist sdist bdist_wheel
+
+if ! [ -d "dist" ]; then
+  echo 'Error: dist folder is not found.' >&2
+  exit 1
+fi
+
+python3 -m twine upload dist/*
+
+rm -rf dist
+rm -rf build
+rm -rf *.egg-info
+find . -name "*.pyc" -exec rm -rf {}\;
