Skip to content

Commit a76193f

Browse files
author
esfiam
committed
feat: initial release of DeepRecon v1.0.0
0 parents  commit a76193f

28 files changed

+3014
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: '[BUG] '
5+
labels: 'bug'
6+
assignees: 'DeepPythonist'
7+
8+
---
9+
10+
## 🐛 Bug Description
11+
A clear and concise description of what the bug is.
12+
13+
## 🔄 To Reproduce
14+
Steps to reproduce the behavior:
15+
1. Import '...'
16+
2. Call function '....'
17+
3. With parameters '....'
18+
4. See error
19+
20+
## ✅ Expected Behavior
21+
A clear and concise description of what you expected to happen.
22+
23+
## 📋 Actual Behavior
24+
A clear and concise description of what actually happened.
25+
26+
## 💻 Environment
27+
- OS: [e.g. Ubuntu 20.04, Windows 10, macOS 12.0]
28+
- Python version: [e.g. 3.9.7]
29+
- DeepRecon version: [e.g. 1.0.0]
30+
31+
## 📊 Code Sample
32+
```python
33+
# Minimal code sample that reproduces the issue
34+
from deeprecon import ...
35+
36+
# Your code here
37+
```
38+
39+
## 📸 Error Output
40+
```
41+
Paste the full error traceback here
42+
```
43+
44+
## 📝 Additional Context
45+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: '[FEATURE] '
5+
labels: 'enhancement'
6+
assignees: 'DeepPythonist'
7+
8+
---
9+
10+
## 💡 Feature Description
11+
A clear and concise description of what you want to happen.
12+
13+
## 🎯 Problem Statement
14+
Is your feature request related to a problem? Please describe.
15+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
16+
17+
## 💭 Proposed Solution
18+
Describe the solution you'd like
19+
A clear and concise description of what you want to happen.
20+
21+
## 🔄 Alternative Solutions
22+
Describe alternatives you've considered
23+
A clear and concise description of any alternative solutions or features you've considered.
24+
25+
## 📊 Use Case
26+
Provide a specific use case for this feature:
27+
```python
28+
# Example of how the feature would be used
29+
from deeprecon import new_module
30+
31+
result = new_module.new_function('example.com')
32+
print(result)
33+
```
34+
35+
## 🎉 Expected Outcome
36+
What would this feature enable users to do?
37+
38+
## 📋 Acceptance Criteria
39+
- [ ] Feature does X
40+
- [ ] Feature supports Y
41+
- [ ] Documentation is updated
42+
- [ ] Tests are added
43+
44+
## 📝 Additional Context
45+
Add any other context or screenshots about the feature request here.

‎.github/workflows/ci.yml

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
name: CI/CD Pipeline
2+
3+
on:
4+
push:
5+
branches: [ main, develop ]
6+
pull_request:
7+
branches: [ main ]
8+
release:
9+
types: [ published ]
10+
11+
jobs:
12+
test:
13+
runs-on: ${{ matrix.os }}
14+
strategy:
15+
matrix:
16+
os: [ubuntu-latest, windows-latest, macos-latest]
17+
python-version: [3.8, 3.9, '3.10', '3.11', '3.12']
18+
19+
steps:
20+
- uses: actions/checkout@v4
21+
22+
- name: Set up Python ${{ matrix.python-version }}
23+
uses: actions/setup-python@v4
24+
with:
25+
python-version: ${{ matrix.python-version }}
26+
27+
- name: Install dependencies
28+
run: |
29+
python -m pip install --upgrade pip
30+
pip install -r requirements.txt
31+
pip install -e .
32+
33+
- name: Lint with flake8
34+
run: |
35+
pip install flake8
36+
flake8 deeprecon --count --select=E9,F63,F7,F82 --show-source --statistics
37+
flake8 deeprecon --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
38+
39+
- name: Test with pytest
40+
run: |
41+
pip install pytest pytest-cov
42+
pytest tests/ --cov=deeprecon --cov-report=xml
43+
44+
- name: Upload coverage to Codecov
45+
uses: codecov/codecov-action@v3
46+
with:
47+
file: ./coverage.xml
48+
flags: unittests
49+
name: codecov-umbrella
50+
51+
security:
52+
runs-on: ubuntu-latest
53+
steps:
54+
- uses: actions/checkout@v4
55+
56+
- name: Run Bandit Security Scan
57+
uses: securecodewarrior/github-action-bandit@v1
58+
with:
59+
buildcommand: "pip install -r requirements.txt"
60+
61+
publish:
62+
needs: [test, security]
63+
runs-on: ubuntu-latest
64+
if: github.event_name == 'release' && github.event.action == 'published'
65+
66+
steps:
67+
- uses: actions/checkout@v4
68+
69+
- name: Set up Python
70+
uses: actions/setup-python@v4
71+
with:
72+
python-version: '3.11'
73+
74+
- name: Install dependencies
75+
run: |
76+
python -m pip install --upgrade pip
77+
pip install build twine
78+
79+
- name: Build package
80+
run: python -m build
81+
82+
- name: Publish to PyPI
83+
env:
84+
TWINE_USERNAME: __token__
85+
TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
86+
run: twine upload dist/*

‎.gitignore

Lines changed: 152 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,152 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
pip-wheel-metadata/
24+
share/python-wheels/
25+
*.egg-info/
26+
.installed.cfg
27+
*.egg
28+
MANIFEST
29+
30+
# PyInstaller
31+
# Usually these files are written by a python script from a template
32+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
33+
*.manifest
34+
*.spec
35+
36+
# Installer logs
37+
pip-log.txt
38+
pip-delete-this-directory.txt
39+
40+
# Unit test / coverage reports
41+
htmlcov/
42+
.tox/
43+
.nox/
44+
.coverage
45+
.coverage.*
46+
.cache
47+
nosetests.xml
48+
coverage.xml
49+
*.cover
50+
*.py,cover
51+
.hypothesis/
52+
.pytest_cache/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
target/
76+
77+
# Jupyter Notebook
78+
.ipynb_checkpoints
79+
80+
# IPython
81+
profile_default/
82+
ipython_config.py
83+
84+
# pyenv
85+
.python-version
86+
87+
# pipenv
88+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
89+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
90+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
91+
# install all needed dependencies.
92+
#Pipfile.lock
93+
94+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
95+
__pypackages__/
96+
97+
# Celery stuff
98+
celerybeat-schedule
99+
celerybeat.pid
100+
101+
# SageMath parsed files
102+
*.sage.py
103+
104+
# Environments
105+
.env
106+
.venv
107+
env/
108+
venv/
109+
ENV/
110+
env.bak/
111+
venv.bak/
112+
113+
# Spyder project settings
114+
.spyderproject
115+
.spyproject
116+
117+
# Rope project settings
118+
.ropeproject
119+
120+
# mkdocs documentation
121+
/site
122+
123+
# mypy
124+
.mypy_cache/
125+
.dmypy.json
126+
dmypy.json
127+
128+
# Pyre type checker
129+
.pyre/
130+
131+
# IDE
132+
.vscode/
133+
.idea/
134+
*.swp
135+
*.swo
136+
*~
137+
138+
# OS
139+
.DS_Store
140+
.DS_Store?
141+
._*
142+
.Spotlight-V100
143+
.Trashes
144+
ehthumbs.db
145+
Thumbs.db
146+
147+
# Project specific
148+
test.py
149+
tests/
150+
*.log
151+
temp/
152+
tmp/

0 commit comments

Comments
 (0)