Merge remote-tracking branch 'origin/main'

Кирилл Горелов · Кирилл Горелов · commit 687cb6c75cb4 · 2025-05-17T13:37:25.000+03:00
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,35 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+### Describe the bug
+A clear and concise description of what the bug is.
+
+### To Reproduce
+Steps to reproduce the behavior:
+1. Run the script: `python your_script.py`
+2. Use the input file `example.csv`
+3. Error appears on function `insert_csv_to_db`
+
+### Expected behavior
+What did you expect to happen?
+
+### Actual behavior
+What actually happened? Include traceback or error message if possible.
+
+### Environment:
+- OS: (e.g. Ubuntu 22.04 / Windows 10)
+- Python version: (e.g. 3.10)
+- insert-tools version: (e.g. 1.0.3)
+- Database: (e.g. PostgreSQL 15, SQLite 3.39)
+
+### Screenshots / Logs
+Paste relevant log output or attach screenshots if applicable.
+
+### Additional context
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/custom.md b/.github/ISSUE_TEMPLATE/custom.md
@@ -0,0 +1,21 @@
+---
+name: Custom issue template
+about: Describe this issue template's purpose here.
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+### Your Question
+Please describe your question as clearly as possible.  
+For example: *"How does `insert_csv_to_db` handle NULL values?"*
+
+### What have you tried?
+Let us know what you've attempted already (if anything), such as checking the documentation or trying a workaround.
+
+### insert-tools version
+e.g. 1.0.3
+
+### Additional context
+Any other details that might help us answer your question. Logs, links, examples — everything helps!
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,23 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+### Is your feature request related to a problem? Please describe
+A clear and concise description of what the problem is.  
+For example: *"I'm always frustrated when I have to manually format large CSVs before inserting them..."*
+
+### Describe the solution you'd like
+A clear and concise description of what you want to happen.  
+What should this feature do? How would it improve your workflow?
+
+### Describe alternatives you've considered
+Any alternative solutions or features you’ve thought about.
+
+### Additional context
+Add any other context, examples, or mockups here.  
+Screenshots or pseudo-code are welcome if helpful.
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible 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.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+k.n.gorelov@gmail.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,76 @@
+# Contributing to insert-tools
+
+Thanks for your interest in contributing! We welcome all contributions — bug reports, feature suggestions, code improvements, documentation, and more.
+
+## How to Contribute
+
+### 1. Fork the Repository
+
+Click the "Fork" button in the top right corner of the [repo](https://github.com/castengine/insert-tools).
+
+### 2. Clone Your Fork
+
+```bash
+git clone https://github.com/yourusername/insert-tools.git
+cd insert-tools
+```
+
+### 3. Create a Feature Branch
+
+```bash
+git checkout -b feature/your-feature-name
+```
+
+### 4. Make Changes and Commit
+
+Make your changes, and commit them:
+
+```bash
+git add .
+git commit -m "Add a clear message about what you changed"
+```
+
+### 5. Push to GitHub
+
+```bash
+git push origin feature/your-feature-name
+```
+
+### 6. Create a Pull Request
+
+Go to your forked repository, click "New Pull Request", and follow the instructions.
+
+---
+
+## 🐛 Reporting Bugs
+
+- Use GitHub [Issues](https://github.com/castengine/insert-tools/issues)
+- Please provide steps to reproduce, expected vs actual behavior, and environment info (OS, Python version, etc.)
+
+---
+
+## 💡 Feature Suggestions
+
+Open an issue and label it with `enhancement`. Describe:
+- What problem this feature solves
+- How it should work
+
+---
+
+## 📋 Code Style
+
+- Use `black` or `isort` for formatting
+- Keep functions small and clear
+- Write docstrings and comments for clarity
+
+---
+
+## ✅ Checklist Before Submitting
+
+- [ ] Code compiles / runs without error
+- [ ] Tests pass (if applicable)
+- [ ] Includes documentation or examples (if needed)
+
+---
+
+Thank you for contributing 🙏
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Kirill Gorelov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/SECURITY.md b/SECURITY.md
@@ -0,0 +1,22 @@
+# Security Policy
+
+## Supported Versions
+
+The table below outlines which versions of `insert-tools` are currently supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.x     | :white_check_mark: |
+| 0.x     | :x:                |
+
+## Reporting a Vulnerability
+
+To report a vulnerability, please open a confidential issue or email us at **security@castengine.dev** (replace with your preferred contact).
+
+We aim to:
+- Acknowledge receipt within 48 hours
+- Investigate the issue promptly
+- Keep you updated during the process
+- Credit you if desired once resolved (optional)
+
+Thank you for helping us keep the project secure!
