-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c478937
commit 3120f09
Showing
23 changed files
with
943 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
We, the members, contributors, and maintainers of this project, pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to 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 toward 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 | ||
|
||
## Enforcement | ||
|
||
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. | ||
|
||
## Reporting | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [[email protected]]. All complaints will be reviewed and investigated, and will result in a response that is deemed necessary and appropriate to the circumstances. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# Contributing to Auto Website Visitor | ||
|
||
Thank you for your interest in contributing to **Auto Website Visitor**! | ||
|
||
## How to Contribute | ||
|
||
### Reporting Issues | ||
|
||
If you find a bug or have an issue, please report it via GitHub Issues. Make sure to include a detailed description and steps to reproduce the issue. For feature requests, please use the Feature Request template. | ||
|
||
### Submitting Code | ||
|
||
1. Fork the repository and create a new branch (`git checkout -b feature-branch`). | ||
2. Make your changes in this branch. | ||
3. Commit your changes (`git commit -am 'Add new feature'`). | ||
4. Push your branch to your fork (`git push origin feature-branch`). | ||
5. Open a Pull Request to the `main` branch of the original repository. | ||
|
||
### Code Style | ||
|
||
- Follow the [PEP 8](https://www.python.org/dev/peps/pep-0008/) coding style for Python code. | ||
- Ensure that your code is clean and well-documented. | ||
- Write tests for your code (if applicable). | ||
|
||
## Code of Conduct | ||
|
||
Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md). | ||
|
||
We welcome contributions and look forward to seeing your improvements to the project! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
## Bug Report | ||
|
||
**Describe the bug** | ||
|
||
A clear and concise description of what the bug is. | ||
|
||
**To Reproduce** | ||
|
||
Steps to reproduce the behavior: | ||
1. Step 1 | ||
2. Step 2 | ||
3. Step 3 | ||
4. See error | ||
|
||
**Expected behavior** | ||
|
||
A clear and concise description of what you expected to happen. | ||
|
||
**Environment:** | ||
- OS: [e.g., Windows 10, Ubuntu 20.04] | ||
- Python version: [e.g., 3.9] | ||
- Version of Auto Website Visitor: [e.g., v0.0.1] | ||
|
||
**Logs** | ||
- Please provide any relevant logs or screenshots that can help us understand the issue. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
## Feature Request | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
|
||
A clear and concise description of what the problem is. Ex. I'm always frustrated when... | ||
|
||
**Describe the solution you'd like** | ||
|
||
A clear and concise description of what you want to happen. | ||
|
||
**Describe alternatives you've considered** | ||
|
||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
|
||
Add any other context or screenshots about the feature request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
## Description | ||
|
||
**Please describe the changes made and why they are necessary.** | ||
|
||
## Related Issue | ||
|
||
**Please link any related issues (e.g., Fixes #123).** | ||
|
||
## Type of Change | ||
|
||
- [ ] Bug fix | ||
- [ ] New feature | ||
- [ ] Documentation update | ||
- [ ] Other (please describe) | ||
|
||
## Checklist | ||
|
||
- [ ] I have followed the project's code of conduct. | ||
- [ ] I have written tests for my changes. | ||
- [ ] My code is clean and well-commented. | ||
- [ ] I have updated the documentation (if needed). | ||
- [ ] I have tested my changes and they work as expected. | ||
|
||
## Additional Information | ||
|
||
**Is there any other context you'd like to provide?** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
# 🔒 SECURITY POLICY 🛡️ | ||
|
||
Hey there, awesome devs! 👋 We’re super hyped that you’re using **Auto Website Visitor** 🚀. Let’s make sure it stays secure for everyone. Below are the deets you need to know about reporting security issues. 💻✨ | ||
|
||
--- | ||
|
||
## 🆘 Found a Bug or Vulnerability? 👀🐛 | ||
|
||
Uh-oh! If you’ve stumbled upon a security issue, don’t panic 😅—we’ve got you covered: | ||
|
||
1. **Slide into our inbox**: | ||
📩 Email us at **[email protected]** ASAP. | ||
(Keep it secret, keep it safe. Don’t post it publicly! 🔐) | ||
|
||
2. **Be specific, plz**: | ||
Share all the tea ☕: | ||
- What happened? | ||
- Steps to reproduce (screenshots or logs? Even better!). | ||
- Why is it a security issue? 👀 | ||
|
||
3. **Wait for the vibes**: | ||
We’ll hit you back within **48 hours**, tops. Pinky promise! 🤞 | ||
|
||
--- | ||
|
||
## 👑 Our Commitment to Security ✨ | ||
|
||
We take security **very seriously** 🫡. That means: | ||
- Patching vulnerabilities 🛠️ FAST. | ||
- Keeping you updated 🗞️ if something goes south. | ||
|
||
Let’s vibe together to keep this project **safe and sound** for everyone. 💙 | ||
|
||
--- | ||
|
||
## 🔐 Supported Versions | ||
|
||
We only provide security updates for the **latest version** of the project. | ||
So, if you’re still vibin’ with an old version, it’s time to level up! ⬆️✨ | ||
|
||
| Version | Supported? 📢 | | ||
|---------|---------------| | ||
| 0.0.1 | ✅ Yessir! | | ||
|
||
--- | ||
|
||
## 🛠️ Security Besties (aka Tools We Use) | ||
|
||
We ❤️: | ||
- **Dependabot** for spotting risky dependencies. | ||
- Regular audits with tools like **Bandit** and **PyUp**. | ||
|
||
Wanna suggest something cool? Hit us up! 💌 | ||
|
||
--- | ||
|
||
## 🖤 Thank You for Helping! 🙌 | ||
|
||
You = a literal superhero 🦸♂️🦸♀️ for making this project better and safer. | ||
Let’s build something amazing **together**! 💪🔥 | ||
|
||
Stay secure, | ||
**Team Auto Website Visitor** ✨ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
name: Python Package CI and Publish | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
pull_request: | ||
branches: | ||
- main | ||
|
||
jobs: | ||
test: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Checkout repository | ||
uses: actions/checkout@v3 | ||
|
||
- name: Set up Python | ||
uses: actions/setup-python@v4 | ||
with: | ||
python-version: "3.9" | ||
|
||
- name: Install dependencies | ||
run: | | ||
python -m pip install --upgrade pip | ||
pip install -r requirements.txt | ||
- name: Run tests | ||
run: pytest | ||
|
||
build-and-publish: | ||
needs: test # Ensures this job runs only if the 'test' job succeeds | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Checkout repository | ||
uses: actions/checkout@v3 | ||
|
||
- name: Set up Python | ||
uses: actions/setup-python@v4 | ||
with: | ||
python-version: "3.9" | ||
|
||
- name: Install build tools | ||
run: python -m pip install --upgrade pip setuptools wheel twine | ||
|
||
- name: Build the package | ||
run: | | ||
python setup.py sdist bdist_wheel | ||
- name: Verify the package | ||
run: | | ||
twine check dist/* | ||
- name: Publish to PyPI | ||
if: github.ref == 'refs/heads/main' && github.event_name == 'push' | ||
env: | ||
TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }} | ||
TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }} | ||
run: | | ||
python -m twine upload dist/* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# Python bytecode files | ||
*.pyc | ||
*.pyo | ||
*.pyd | ||
__pycache__/ | ||
|
||
# Virtual environment directories | ||
.venv/ | ||
|
||
# Windows system files | ||
Thumbs.db | ||
|
||
# Logs | ||
*.log | ||
|
||
# Distribution / packaging | ||
*.egg | ||
*.egg-info/ | ||
dist/ | ||
build/ | ||
*.tar.gz | ||
*.zip | ||
|
||
# PyInstaller files | ||
*.spec | ||
|
||
# Test-related files | ||
nosetests.xml | ||
coverage.xml | ||
*.cover | ||
*.hypothesis/ | ||
|
||
# Jupyter Notebook checkpoints | ||
.ipynb_checkpoints/ | ||
|
||
# Environment variable files | ||
.env | ||
|
||
# Other | ||
*.bak | ||
*.tmp |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2025 nayandas69 | ||
|
||
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. |
Oops, something went wrong.