commit
434fbb342f
@ -0,0 +1,778 @@ |
||||
|
||||
# Created by https://www.gitignore.io/api/osx,python,pycharm,windows,visualstudio,visualstudiocode |
||||
# Edit at https://www.gitignore.io/?templates=osx,python,pycharm,windows,visualstudio,visualstudiocode |
||||
|
||||
### OSX ### |
||||
# General |
||||
.DS_Store |
||||
.AppleDouble |
||||
.LSOverride |
||||
|
||||
# Icon must end with two \r |
||||
Icon |
||||
|
||||
# Thumbnails |
||||
._* |
||||
|
||||
# Files that might appear in the root of a volume |
||||
.DocumentRevisions-V100 |
||||
.fseventsd |
||||
.Spotlight-V100 |
||||
.TemporaryItems |
||||
.Trashes |
||||
.VolumeIcon.icns |
||||
.com.apple.timemachine.donotpresent |
||||
|
||||
# Directories potentially created on remote AFP share |
||||
.AppleDB |
||||
.AppleDesktop |
||||
Network Trash Folder |
||||
Temporary Items |
||||
.apdisk |
||||
|
||||
### PyCharm ### |
||||
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm |
||||
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 |
||||
|
||||
# User-specific stuff |
||||
.idea/**/workspace.xml |
||||
.idea/**/tasks.xml |
||||
.idea/**/usage.statistics.xml |
||||
.idea/**/dictionaries |
||||
.idea/**/shelf |
||||
|
||||
# Generated files |
||||
.idea/**/contentModel.xml |
||||
|
||||
# Sensitive or high-churn files |
||||
.idea/**/dataSources/ |
||||
.idea/**/dataSources.ids |
||||
.idea/**/dataSources.local.xml |
||||
.idea/**/sqlDataSources.xml |
||||
.idea/**/dynamic.xml |
||||
.idea/**/uiDesigner.xml |
||||
.idea/**/dbnavigator.xml |
||||
|
||||
# Gradle |
||||
.idea/**/gradle.xml |
||||
.idea/**/libraries |
||||
|
||||
# Gradle and Maven with auto-import |
||||
# When using Gradle or Maven with auto-import, you should exclude module files, |
||||
# since they will be recreated, and may cause churn. Uncomment if using |
||||
# auto-import. |
||||
# .idea/modules.xml |
||||
# .idea/*.iml |
||||
# .idea/modules |
||||
# *.iml |
||||
# *.ipr |
||||
|
||||
# CMake |
||||
cmake-build-*/ |
||||
|
||||
# Mongo Explorer plugin |
||||
.idea/**/mongoSettings.xml |
||||
|
||||
# File-based project format |
||||
*.iws |
||||
|
||||
# IntelliJ |
||||
out/ |
||||
|
||||
# mpeltonen/sbt-idea plugin |
||||
.idea_modules/ |
||||
|
||||
# JIRA plugin |
||||
atlassian-ide-plugin.xml |
||||
|
||||
# Cursive Clojure plugin |
||||
.idea/replstate.xml |
||||
|
||||
# Crashlytics plugin (for Android Studio and IntelliJ) |
||||
com_crashlytics_export_strings.xml |
||||
crashlytics.properties |
||||
crashlytics-build.properties |
||||
fabric.properties |
||||
|
||||
# Editor-based Rest Client |
||||
.idea/httpRequests |
||||
|
||||
# Android studio 3.1+ serialized cache file |
||||
.idea/caches/build_file_checksums.ser |
||||
|
||||
### PyCharm Patch ### |
||||
# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721 |
||||
|
||||
# *.iml |
||||
# modules.xml |
||||
# .idea/misc.xml |
||||
# *.ipr |
||||
|
||||
# Sonarlint plugin |
||||
.idea/**/sonarlint/ |
||||
|
||||
# SonarQube Plugin |
||||
.idea/**/sonarIssues.xml |
||||
|
||||
# Markdown Navigator plugin |
||||
.idea/**/markdown-navigator.xml |
||||
.idea/**/markdown-navigator/ |
||||
|
||||
### Python ### |
||||
# Byte-compiled / optimized / DLL files |
||||
__pycache__/ |
||||
*.py[cod] |
||||
*$py.class |
||||
|
||||
# C extensions |
||||
*.so |
||||
|
||||
# Distribution / packaging |
||||
.Python |
||||
build/ |
||||
develop-eggs/ |
||||
dist/ |
||||
downloads/ |
||||
eggs/ |
||||
.eggs/ |
||||
lib/ |
||||
lib64/ |
||||
parts/ |
||||
sdist/ |
||||
var/ |
||||
wheels/ |
||||
pip-wheel-metadata/ |
||||
share/python-wheels/ |
||||
*.egg-info/ |
||||
.installed.cfg |
||||
*.egg |
||||
MANIFEST |
||||
|
||||
# PyInstaller |
||||
# Usually these files are written by a python script from a template |
||||
# before PyInstaller builds the exe, so as to inject date/other infos into it. |
||||
*.manifest |
||||
*.spec |
||||
|
||||
# Installer logs |
||||
pip-log.txt |
||||
pip-delete-this-directory.txt |
||||
|
||||
# Unit test / coverage reports |
||||
htmlcov/ |
||||
.tox/ |
||||
.nox/ |
||||
.coverage |
||||
.coverage.* |
||||
.cache |
||||
nosetests.xml |
||||
coverage.xml |
||||
*.cover |
||||
.hypothesis/ |
||||
.pytest_cache/ |
||||
|
||||
# Translations |
||||
*.mo |
||||
*.pot |
||||
|
||||
# Scrapy stuff: |
||||
.scrapy |
||||
|
||||
# Sphinx documentation |
||||
docs/_build/ |
||||
|
||||
# PyBuilder |
||||
target/ |
||||
|
||||
# pyenv |
||||
.python-version |
||||
|
||||
# poetry |
||||
.venv |
||||
|
||||
# pipenv |
||||
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. |
||||
# However, in case of collaboration, if having platform-specific dependencies or dependencies |
||||
# having no cross-platform support, pipenv may install dependencies that don't work, or not |
||||
# install all needed dependencies. |
||||
#Pipfile.lock |
||||
|
||||
# celery beat schedule file |
||||
celerybeat-schedule |
||||
|
||||
# SageMath parsed files |
||||
*.sage.py |
||||
|
||||
# Spyder project settings |
||||
.spyderproject |
||||
.spyproject |
||||
|
||||
# Rope project settings |
||||
.ropeproject |
||||
|
||||
# Mr Developer |
||||
.mr.developer.cfg |
||||
.project |
||||
.pydevproject |
||||
|
||||
# mkdocs documentation |
||||
/site |
||||
|
||||
# mypy |
||||
.mypy_cache/ |
||||
.dmypy.json |
||||
dmypy.json |
||||
|
||||
# Pyre type checker |
||||
.pyre/ |
||||
|
||||
# Plugins |
||||
.secrets.baseline |
||||
|
||||
### VisualStudioCode ### |
||||
.vscode/* |
||||
!.vscode/tasks.json |
||||
!.vscode/launch.json |
||||
!.vscode/extensions.json |
||||
|
||||
### VisualStudioCode Patch ### |
||||
# Ignore all local history of files |
||||
.history |
||||
|
||||
### Windows ### |
||||
# Windows thumbnail cache files |
||||
Thumbs.db |
||||
Thumbs.db:encryptable |
||||
ehthumbs.db |
||||
ehthumbs_vista.db |
||||
|
||||
# Dump file |
||||
*.stackdump |
||||
|
||||
# Folder config file |
||||
[Dd]esktop.ini |
||||
|
||||
# Recycle Bin used on file shares |
||||
$RECYCLE.BIN/ |
||||
|
||||
# Windows Installer files |
||||
*.cab |
||||
*.msi |
||||
*.msix |
||||
*.msm |
||||
*.msp |
||||
|
||||
# Windows shortcuts |
||||
*.lnk |
||||
|
||||
### VisualStudio ### |
||||
## Ignore Visual Studio temporary files, build results, and |
||||
## files generated by popular Visual Studio add-ons. |
||||
## |
||||
## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore |
||||
|
||||
# User-specific files |
||||
*.rsuser |
||||
*.suo |
||||
*.user |
||||
*.userosscache |
||||
*.sln.docstates |
||||
|
||||
# User-specific files (MonoDevelop/Xamarin Studio) |
||||
*.userprefs |
||||
|
||||
# Mono auto generated files |
||||
mono_crash.* |
||||
|
||||
# Build results |
||||
[Dd]ebug/ |
||||
[Dd]ebugPublic/ |
||||
[Rr]elease/ |
||||
[Rr]eleases/ |
||||
x64/ |
||||
x86/ |
||||
[Aa][Rr][Mm]/ |
||||
[Aa][Rr][Mm]64/ |
||||
bld/ |
||||
[Bb]in/ |
||||
[Oo]bj/ |
||||
[Ll]og/ |
||||
|
||||
# Visual Studio 2015/2017 cache/options directory |
||||
.vs/ |
||||
# Uncomment if you have tasks that create the project's static files in wwwroot |
||||
#wwwroot/ |
||||
|
||||
# Visual Studio 2017 auto generated files |
||||
Generated\ Files/ |
||||
|
||||
# MSTest test Results |
||||
[Tt]est[Rr]esult*/ |
||||
[Bb]uild[Ll]og.* |
||||
|
||||
# NUnit |
||||
*.VisualState.xml |
||||
TestResult.xml |
||||
nunit-*.xml |
||||
|
||||
# Build Results of an ATL Project |
||||
[Dd]ebugPS/ |
||||
[Rr]eleasePS/ |
||||
dlldata.c |
||||
|
||||
# Benchmark Results |
||||
BenchmarkDotNet.Artifacts/ |
||||
|
||||
# .NET Core |
||||
project.lock.json |
||||
project.fragment.lock.json |
||||
artifacts/ |
||||
|
||||
# StyleCop |
||||
StyleCopReport.xml |
||||
|
||||
# Files built by Visual Studio |
||||
*_i.c |
||||
*_p.c |
||||
*_h.h |
||||
*.ilk |
||||
*.obj |
||||
*.iobj |
||||
*.pch |
||||
*.pdb |
||||
*.ipdb |
||||
*.pgc |
||||
*.pgd |
||||
*.rsp |
||||
*.sbr |
||||
*.tlb |
||||
*.tli |
||||
*.tlh |
||||
*.tmp |
||||
*.tmp_proj |
||||
*_wpftmp.csproj |
||||
*.log |
||||
*.vspscc |
||||
*.vssscc |
||||
.builds |
||||
*.pidb |
||||
*.svclog |
||||
*.scc |
||||
|
||||
# Chutzpah Test files |
||||
_Chutzpah* |
||||
|
||||
# Visual C++ cache files |
||||
ipch/ |
||||
*.aps |
||||
*.ncb |
||||
*.opendb |
||||
*.opensdf |
||||
*.sdf |
||||
*.cachefile |
||||
*.VC.db |
||||
*.VC.VC.opendb |
||||
|
||||
# Visual Studio profiler |
||||
*.psess |
||||
*.vsp |
||||
*.vspx |
||||
*.sap |
||||
|
||||
# Visual Studio Trace Files |
||||
*.e2e |
||||
|
||||
# TFS 2012 Local Workspace |
||||
$tf/ |
||||
|
||||
# Guidance Automation Toolkit |
||||
*.gpState |
||||
|
||||
# ReSharper is a .NET coding add-in |
||||
_ReSharper*/ |
||||
*.[Rr]e[Ss]harper |
||||
*.DotSettings.user |
||||
|
||||
# JustCode is a .NET coding add-in |
||||
.JustCode |
||||
|
||||
# TeamCity is a build add-in |
||||
_TeamCity* |
||||
|
||||
# DotCover is a Code Coverage Tool |
||||
*.dotCover |
||||
|
||||
# AxoCover is a Code Coverage Tool |
||||
.axoCover/* |
||||
!.axoCover/settings.json |
||||
|
||||
# Visual Studio code coverage results |
||||
*.coverage |
||||
*.coveragexml |
||||
|
||||
# NCrunch |
||||
_NCrunch_* |
||||
.*crunch*.local.xml |
||||
nCrunchTemp_* |
||||
|
||||
# MightyMoose |
||||
*.mm.* |
||||
AutoTest.Net/ |
||||
|
||||
# Web workbench (sass) |
||||
.sass-cache/ |
||||
|
||||
# Installshield output folder |
||||
[Ee]xpress/ |
||||
|
||||
# DocProject is a documentation generator add-in |
||||
DocProject/buildhelp/ |
||||
DocProject/Help/*.HxT |
||||
DocProject/Help/*.HxC |
||||
DocProject/Help/*.hhc |
||||
DocProject/Help/*.hhk |
||||
DocProject/Help/*.hhp |
||||
DocProject/Help/Html2 |
||||
DocProject/Help/html |
||||
|
||||
# Click-Once directory |
||||
publish/ |
||||
|
||||
# Publish Web Output |
||||
*.[Pp]ublish.xml |
||||
*.azurePubxml |
||||
# Note: Comment the next line if you want to checkin your web deploy settings, |
||||
# but database connection strings (with potential passwords) will be unencrypted |
||||
*.pubxml |
||||
*.publishproj |
||||
|
||||
# Microsoft Azure Web App publish settings. Comment the next line if you want to |
||||
# checkin your Azure Web App publish settings, but sensitive information contained |
||||
# in these scripts will be unencrypted |
||||
PublishScripts/ |
||||
|
||||
# NuGet Packages |
||||
*.nupkg |
||||
# NuGet Symbol Packages |
||||
*.snupkg |
||||
# The packages folder can be ignored because of Package Restore |
||||
**/[Pp]ackages/* |
||||
# except build/, which is used as an MSBuild target. |
||||
!**/[Pp]ackages/build/ |
||||
# Uncomment if necessary however generally it will be regenerated when needed |
||||
#!**/[Pp]ackages/repositories.config |
||||
# NuGet v3's project.json files produces more ignorable files |
||||
*.nuget.props |
||||
*.nuget.targets |
||||
|
||||
# Microsoft Azure Build Output |
||||
csx/ |
||||
*.build.csdef |
||||
|
||||
# Microsoft Azure Emulator |
||||
ecf/ |
||||
rcf/ |
||||
|
||||
# Windows Store app package directories and files |
||||
AppPackages/ |
||||
BundleArtifacts/ |
||||
Package.StoreAssociation.xml |
||||
_pkginfo.txt |
||||
*.appx |
||||
*.appxbundle |
||||
*.appxupload |
||||
|
||||
# Visual Studio cache files |
||||
# files ending in .cache can be ignored |
||||
*.[Cc]ache |
||||
# but keep track of directories ending in .cache |
||||
!?*.[Cc]ache/ |
||||
|
||||
# Others |
||||
ClientBin/ |
||||
~$* |
||||
*~ |
||||
*.dbmdl |
||||
*.dbproj.schemaview |
||||
*.jfm |
||||
*.pfx |
||||
*.publishsettings |
||||
orleans.codegen.cs |
||||
|
||||
# Including strong name files can present a security risk |
||||
# (https://github.com/github/gitignore/pull/2483#issue-259490424) |
||||
#*.snk |
||||
|
||||
# Since there are multiple workflows, uncomment next line to ignore bower_components |
||||
# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) |
||||
#bower_components/ |
||||
|
||||
# RIA/Silverlight projects |
||||
Generated_Code/ |
||||
|
||||
# Backup & report files from converting an old project file |
||||
# to a newer Visual Studio version. Backup files are not needed, |
||||
# because we have git ;-) |
||||
_UpgradeReport_Files/ |
||||
Backup*/ |
||||
UpgradeLog*.XML |
||||
UpgradeLog*.htm |
||||
ServiceFabricBackup/ |
||||
*.rptproj.bak |
||||
|
||||
# SQL Server files |
||||
*.mdf |
||||
*.ldf |
||||
*.ndf |
||||
|
||||
# Business Intelligence projects |
||||
*.rdl.data |
||||
*.bim.layout |
||||
*.bim_*.settings |
||||
*.rptproj.rsuser |
||||
*- [Bb]ackup.rdl |
||||
*- [Bb]ackup ([0-9]).rdl |
||||
*- [Bb]ackup ([0-9][0-9]).rdl |
||||
|
||||
# Microsoft Fakes |
||||
FakesAssemblies/ |
||||
|
||||
# GhostDoc plugin setting file |
||||
*.GhostDoc.xml |
||||
|
||||
# Node.js Tools for Visual Studio |
||||
.ntvs_analysis.dat |
||||
node_modules/ |
||||
|
||||
# Visual Studio 6 build log |
||||
*.plg |
||||
|
||||
# Visual Studio 6 workspace options file |
||||
*.opt |
||||
|
||||
# Visual Studio 6 auto-generated workspace file (contains which files were open etc.) |
||||
*.vbw |
||||
|
||||
# Visual Studio LightSwitch build output |
||||
**/*.HTMLClient/GeneratedArtifacts |
||||
**/*.DesktopClient/GeneratedArtifacts |
||||
**/*.DesktopClient/ModelManifest.xml |
||||
**/*.Server/GeneratedArtifacts |
||||
**/*.Server/ModelManifest.xml |
||||
_Pvt_Extensions |
||||
|
||||
# Paket dependency manager |
||||
.paket/paket.exe |
||||
paket-files/ |
||||
|
||||
# FAKE - F# Make |
||||
.fake/ |
||||
|
||||
# CodeRush personal settings |
||||
.cr/personal |
||||
|
||||
# Python Tools for Visual Studio (PTVS) |
||||
*.pyc |
||||
|
||||
# Cake - Uncomment if you are using it |
||||
# tools/** |
||||
# !tools/packages.config |
||||
|
||||
# Tabs Studio |
||||
*.tss |
||||
|
||||
# Telerik's JustMock configuration file |
||||
*.jmconfig |
||||
|
||||
# BizTalk build output |
||||
*.btp.cs |
||||
*.btm.cs |
||||
*.odx.cs |
||||
*.xsd.cs |
||||
|
||||
# OpenCover UI analysis results |
||||
OpenCover/ |
||||
|
||||
# Azure Stream Analytics local run output |
||||
ASALocalRun/ |
||||
|
||||
# MSBuild Binary and Structured Log |
||||
*.binlog |
||||
|
||||
# NVidia Nsight GPU debugger configuration file |
||||
*.nvuser |
||||
|
||||
# MFractors (Xamarin productivity tool) working folder |
||||
.mfractor/ |
||||
|
||||
# Local History for Visual Studio |
||||
.localhistory/ |
||||
|
||||
# BeatPulse healthcheck temp database |
||||
healthchecksdb |
||||
|
||||
# Backup folder for Package Reference Convert tool in Visual Studio 2017 |
||||
MigrationBackup/ |
||||
|
||||
# End of https://www.gitignore.io/api/osx,python,pycharm,windows,visualstudio,visualstudiocode |
||||
|
||||
# Byte-compiled / optimized / DLL files |
||||
__pycache__/ |
||||
*.py[cod] |
||||
*$py.class |
||||
|
||||
# C extensions |
||||
*.so |
||||
|
||||
# Distribution / packaging |
||||
.Python |
||||
build/ |
||||
develop-eggs/ |
||||
dist/ |
||||
downloads/ |
||||
eggs/ |
||||
.eggs/ |
||||
lib/ |
||||
lib64/ |
||||
parts/ |
||||
sdist/ |
||||
var/ |
||||
wheels/ |
||||
share/python-wheels/ |
||||
*.egg-info/ |
||||
.installed.cfg |
||||
*.egg |
||||
MANIFEST |
||||
|
||||
# PyInstaller |
||||
# Usually these files are written by a python script from a template |
||||
# before PyInstaller builds the exe, so as to inject date/other infos into it. |
||||
*.manifest |
||||
*.spec |
||||
|
||||
# Installer logs |
||||
pip-log.txt |
||||
pip-delete-this-directory.txt |
||||
|
||||
# Unit test / coverage reports |
||||
htmlcov/ |
||||
.tox/ |
||||
.nox/ |
||||
.coverage |
||||
.coverage.* |
||||
.cache |
||||
nosetests.xml |
||||
coverage.xml |
||||
*.cover |
||||
*.py,cover |
||||
.hypothesis/ |
||||
.pytest_cache/ |
||||
cover/ |
||||
|
||||
# Translations |
||||
*.mo |
||||
*.pot |
||||
|
||||
# Django stuff: |
||||
*.log |
||||
local_settings.py |
||||
db.sqlite3 |
||||
db.sqlite3-journal |
||||
|
||||
# Flask stuff: |
||||
instance/ |
||||
.webassets-cache |
||||
|
||||
# Scrapy stuff: |
||||
.scrapy |
||||
|
||||
# Sphinx documentation |
||||
docs/_build/ |
||||
|
||||
# PyBuilder |
||||
.pybuilder/ |
||||
target/ |
||||
|
||||
# Jupyter Notebook |
||||
.ipynb_checkpoints |
||||
|
||||
# IPython |
||||
profile_default/ |
||||
ipython_config.py |
||||
|
||||
# pyenv |
||||
# For a library or package, you might want to ignore these files since the code is |
||||
# intended to run in multiple environments; otherwise, check them in: |
||||
# .python-version |
||||
|
||||
# pipenv |
||||
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. |
||||
# However, in case of collaboration, if having platform-specific dependencies or dependencies |
||||
# having no cross-platform support, pipenv may install dependencies that don't work, or not |
||||
# install all needed dependencies. |
||||
#Pipfile.lock |
||||
|
||||
# poetry |
||||
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. |
||||
# This is especially recommended for binary packages to ensure reproducibility, and is more |
||||
# commonly ignored for libraries. |
||||
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control |
||||
#poetry.lock |
||||
|
||||
# pdm |
||||
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. |
||||
#pdm.lock |
||||
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it |
||||
# in version control. |
||||
# https://pdm.fming.dev/#use-with-ide |
||||
.pdm.toml |
||||
|
||||
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm |
||||
__pypackages__/ |
||||
|
||||
# Celery stuff |
||||
celerybeat-schedule |
||||
celerybeat.pid |
||||
|
||||
# SageMath parsed files |
||||
*.sage.py |
||||
|
||||
# Environments |
||||
.env |
||||
.venv |
||||
env/ |
||||
venv/ |
||||
ENV/ |
||||
env.bak/ |
||||
venv.bak/ |
||||
|
||||
# Spyder project settings |
||||
.spyderproject |
||||
.spyproject |
||||
|
||||
# Rope project settings |
||||
.ropeproject |
||||
|
||||
# mkdocs documentation |
||||
/site |
||||
|
||||
# mypy |
||||
.mypy_cache/ |
||||
.dmypy.json |
||||
dmypy.json |
||||
|
||||
# Pyre type checker |
||||
.pyre/ |
||||
|
||||
# pytype static type analyzer |
||||
.pytype/ |
||||
|
||||
# Cython debug symbols |
||||
cython_debug/ |
||||
|
||||
# PyCharm |
||||
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can |
||||
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore |
||||
# and can be added to the global gitignore or merged into this file. For a more nuclear |
||||
# option (not recommended) you can uncomment the following to ignore the entire idea folder. |
||||
#.idea/ |
||||
@ -0,0 +1,24 @@ |
||||
# Check http://editorconfig.org for more information |
||||
# This is the main config file for this project: |
||||
root = true |
||||
|
||||
[*] |
||||
charset = utf-8 |
||||
end_of_line = lf |
||||
insert_final_newline = true |
||||
indent_style = space |
||||
indent_size = 4 |
||||
trim_trailing_whitespace = true |
||||
|
||||
[*.{py, pyi}] |
||||
indent_style = space |
||||
indent_size = 4 |
||||
|
||||
[Makefile] |
||||
indent_style = tab |
||||
|
||||
[*.md] |
||||
trim_trailing_whitespace = false |
||||
|
||||
[*.{diff,patch}] |
||||
trim_trailing_whitespace = false |
||||
@ -0,0 +1,17 @@ |
||||
# Number of days of inactivity before an issue becomes stale |
||||
daysUntilStale: 60 |
||||
# Number of days of inactivity before a stale issue is closed |
||||
daysUntilClose: 7 |
||||
# Issues with these labels will never be considered stale |
||||
exemptLabels: |
||||
- pinned |
||||
- security |
||||
# Label to use when marking an issue as stale |
||||
staleLabel: wontfix |
||||
# Comment to post when marking an issue as stale. Set to `false` to disable |
||||
markComment: > |
||||
This issue has been automatically marked as stale because it has not had |
||||
recent activity. It will be closed if no further activity occurs. Thank you |
||||
for your contributions. |
||||
# Comment to post when closing a stale issue. Set to `false` to disable |
||||
closeComment: false |
||||
@ -0,0 +1 @@ |
||||
* @thamognya |
||||
@ -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 contact@thamognya.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 |
||||
@ -0,0 +1,47 @@ |
||||
# How to contribute |
||||
|
||||
## Dependencies |
||||
|
||||
We use `poetry` to manage the [dependencies](https://github.com/python-poetry/poetry). |
||||
If you dont have `poetry`, you should install with `make poetry-download`. |
||||
|
||||
To install dependencies and prepare [`pre-commit`](https://pre-commit.com/) hooks you would need to run `install` command: |
||||
|
||||
```bash |
||||
make install |
||||
make pre-commit-install |
||||
``` |
||||
|
||||
To activate your `virtualenv` run `poetry shell`. |
||||
|
||||
## Codestyle |
||||
|
||||
After installation you may execute code formatting. |
||||
|
||||
```bash |
||||
make codestyle |
||||
``` |
||||
|
||||
### Checks |
||||
|
||||
Many checks are configured for this project. Command `make check-codestyle` will check black, isort and darglint. |
||||
The `make check-safety` command will look at the security of your code. |
||||
|
||||
Comand `make lint` applies all checks. |
||||
|
||||
### Before submitting |
||||
|
||||
Before submitting your code please do the following steps: |
||||
|
||||
1. Add any changes you want |
||||
1. Add tests for the new changes |
||||
1. Edit documentation if you have changed something significant |
||||
1. Run `make codestyle` to format your changes. |
||||
1. Run `make lint` to ensure that types, security and docstrings are okay. |
||||
|
||||
## Other help |
||||
|
||||
You can contribute by spreading a word about this library. |
||||
It would also be a huge contribution to write |
||||
a short article on how you are using this project. |
||||
You can also share your best practices with us. |
||||
@ -0,0 +1,42 @@ |
||||
--- |
||||
name: 🐛 Bug report |
||||
about: If something isn't working 🔧 |
||||
title: '' |
||||
labels: bug |
||||
assignees: |
||||
--- |
||||
|
||||
## 🐛 Bug Report |
||||
|
||||
<!-- A clear and concise description of what the bug is. --> |
||||
|
||||
## 🔬 How To Reproduce |
||||
|
||||
Steps to reproduce the behavior: |
||||
|
||||
1. ... |
||||
|
||||
### Code sample |
||||
|
||||
<!-- If applicable, attach a minimal code sample to reproduce the decried issue. --> |
||||
|
||||
### Environment |
||||
|
||||
* OS: [e.g. Linux / Windows / macOS] |
||||
* Python version, get it with: |
||||
|
||||
```bash |
||||
python --version |
||||
``` |
||||
|
||||
### Screenshots |
||||
|
||||
<!-- If applicable, add screenshots to help explain your problem. --> |
||||
|
||||
## 📈 Expected behavior |
||||
|
||||
<!-- A clear and concise description of what you expected to happen. --> |
||||
|
||||
## 📎 Additional context |
||||
|
||||
<!-- Add any other context about the problem here. --> |
||||
@ -0,0 +1,3 @@ |
||||
# Configuration: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository |
||||
|
||||
blank_issues_enabled: false |
||||
@ -0,0 +1,23 @@ |
||||
--- |
||||
name: 🚀 Feature request |
||||
about: Suggest an idea for this project 🏖 |
||||
title: '' |
||||
labels: enhancement |
||||
assignees: |
||||
--- |
||||
|
||||
## 🚀 Feature Request |
||||
|
||||
<!-- A clear and concise description of the feature proposal. --> |
||||
|
||||
## 🔈 Motivation |
||||
|
||||
<!-- Please describe the motivation for this proposal. --> |
||||
|
||||
## 🛰 Alternatives |
||||
|
||||
<!-- 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. --> |
||||
@ -0,0 +1,25 @@ |
||||
--- |
||||
name: ❓ Question |
||||
about: Ask a question about this project 🎓 |
||||
title: '' |
||||
labels: question |
||||
assignees: |
||||
--- |
||||
|
||||
## Checklist |
||||
|
||||
<!-- Mark with an `x` all the checkboxes that apply (like `[x]`) --> |
||||
|
||||
- [ ] I've searched the project's [`issues`](https://github.com/internet-ml/internet-ml/issues?q=is%3Aissue). |
||||
|
||||
## ❓ Question |
||||
|
||||
<!-- What is your question --> |
||||
|
||||
How can I [...]? |
||||
|
||||
Is it possible to [...]? |
||||
|
||||
## 📎 Additional context |
||||
|
||||
<!-- Add any other context or screenshots about the feature request here. --> |
||||
@ -0,0 +1,28 @@ |
||||
## Description |
||||
|
||||
<!-- Add a more detailed description of the changes if needed. --> |
||||
|
||||
## Related Issue |
||||
|
||||
<!-- If your PR refers to a related issue, link it here. --> |
||||
|
||||
## Type of Change |
||||
|
||||
<!-- Mark with an `x` all the checkboxes that apply (like `[x]`) --> |
||||
|
||||
- [ ] 📚 Examples / docs / tutorials / dependencies update |
||||
- [ ] 🔧 Bug fix (non-breaking change which fixes an issue) |
||||
- [ ] 🥂 Improvement (non-breaking change which improves an existing feature) |
||||
- [ ] 🚀 New feature (non-breaking change which adds functionality) |
||||
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to change) |
||||
- [ ] 🔐 Security fix |
||||
|
||||
## Checklist |
||||
|
||||
<!-- Mark with an `x` all the checkboxes that apply (like `[x]`) --> |
||||
|
||||
- [ ] I've read the [`CODE_OF_CONDUCT.md`](https://github.com/internet-ml/internet-ml/blob/master/CODE_OF_CONDUCT.md) document. |
||||
- [ ] I've read the [`CONTRIBUTING.md`](https://github.com/internet-ml/internet-ml/blob/master/CONTRIBUTING.md) guide. |
||||
- [ ] I've updated the code style using `make codestyle`. |
||||
- [ ] I've written tests for all new methods and classes that I created. |
||||
- [ ] I've written the docstring in Google format for all the methods and classes that I used. |
||||
@ -0,0 +1,27 @@ |
||||
# Security |
||||
|
||||
## 🔐 Reporting Security Issues |
||||
|
||||
> Do not open issues that might have security implications! |
||||
> It is critical that security related issues are reported privately so we have time to address them before they become public knowledge. |
||||
|
||||
Vulnerabilities can be reported by emailing core members: |
||||
|
||||
- internet-ml [contact@thamognya.com](mailto:contact@thamognya.com) |
||||
|
||||
Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue: |
||||
|
||||
- Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.) |
||||
- Full paths of source file(s) related to the manifestation of the issue |
||||
- The location of the affected source code (tag/branch/commit or direct URL) |
||||
- Any special configuration required to reproduce the issue |
||||
- Environment (e.g. Linux / Windows / macOS) |
||||
- Step-by-step instructions to reproduce the issue |
||||
- Proof-of-concept or exploit code (if possible) |
||||
- Impact of the issue, including how an attacker might exploit the issue |
||||
|
||||
This information will help us triage your report more quickly. |
||||
|
||||
## Preferred Languages |
||||
|
||||
We prefer all communications to be in English. |
||||
@ -0,0 +1,35 @@ |
||||
# Configuration: https://dependabot.com/docs/config-file/ |
||||
# Docs: https://docs.github.com/en/github/administering-a-repository/keeping-your-dependencies-updated-automatically |
||||
|
||||
version: 2 |
||||
|
||||
updates: |
||||
- package-ecosystem: "pip" |
||||
directory: "/" |
||||
schedule: |
||||
interval: "daily" |
||||
allow: |
||||
- dependency-type: "all" |
||||
commit-message: |
||||
prefix: ":arrow_up:" |
||||
open-pull-requests-limit: 50 |
||||
|
||||
- package-ecosystem: "github-actions" |
||||
directory: "/" |
||||
schedule: |
||||
interval: "daily" |
||||
allow: |
||||
- dependency-type: "all" |
||||
commit-message: |
||||
prefix: ":arrow_up:" |
||||
open-pull-requests-limit: 50 |
||||
|
||||
- package-ecosystem: "docker" |
||||
directory: "/docker" |
||||
schedule: |
||||
interval: "weekly" |
||||
allow: |
||||
- dependency-type: "all" |
||||
commit-message: |
||||
prefix: ":arrow_up:" |
||||
open-pull-requests-limit: 50 |
||||
@ -0,0 +1,28 @@ |
||||
# Release drafter configuration https://github.com/release-drafter/release-drafter#configuration |
||||
# Emojis were chosen to match the https://gitmoji.carloscuesta.me/ |
||||
|
||||
name-template: "v$NEXT_PATCH_VERSION" |
||||
tag-template: "v$NEXT_PATCH_VERSION" |
||||
|
||||
categories: |
||||
- title: ":rocket: Features" |
||||
labels: [enhancement, feature] |
||||
- title: ":wrench: Fixes & Refactoring" |
||||
labels: [bug, refactoring, bugfix, fix] |
||||
- title: ":package: Build System & CI/CD" |
||||
labels: [build, ci, testing] |
||||
- title: ":boom: Breaking Changes" |
||||
labels: [breaking] |
||||
- title: ":pencil: Documentation" |
||||
labels: [documentation] |
||||
- title: ":arrow_up: Dependencies updates" |
||||
labels: [dependencies] |
||||
|
||||
template: | |
||||
## What’s Changed |
||||
|
||||
$CHANGES |
||||
|
||||
## :busts_in_silhouette: List of contributors |
||||
|
||||
$CONTRIBUTORS |
||||
@ -0,0 +1,42 @@ |
||||
name: build |
||||
|
||||
on: [push, pull_request] |
||||
|
||||
jobs: |
||||
build: |
||||
runs-on: ubuntu-latest |
||||
strategy: |
||||
matrix: |
||||
python-version: ["3.11", "3.9"] |
||||
|
||||
steps: |
||||
- uses: actions/checkout@v2 |
||||
- name: Set up Python ${{ matrix.python-version }} |
||||
uses: actions/setup-python@v2.2.2 |
||||
with: |
||||
python-version: ${{ matrix.python-version }} |
||||
|
||||
- name: Install poetry |
||||
run: make poetry-download |
||||
|
||||
- name: Set up cache |
||||
uses: actions/cache@v2.1.6 |
||||
with: |
||||
path: .venv |
||||
key: venv-${{ matrix.python-version }}-${{ hashFiles('pyproject.toml') }}-${{ hashFiles('poetry.lock') }} |
||||
- name: Install dependencies |
||||
run: | |
||||
poetry config virtualenvs.in-project true |
||||
poetry install |
||||
|
||||
- name: Run style checks |
||||
run: | |
||||
make check-codestyle |
||||
|
||||
- name: Run tests |
||||
run: | |
||||
make test |
||||
|
||||
- name: Run safety checks |
||||
run: | |
||||
make check-safety |
||||
@ -0,0 +1,16 @@ |
||||
name: Greetings |
||||
|
||||
on: [pull_request, issues] |
||||
|
||||
jobs: |
||||
greeting: |
||||
runs-on: ubuntu-latest |
||||
steps: |
||||
- uses: actions/first-interaction@v1 |
||||
with: |
||||
repo-token: ${{ secrets.GITHUB_TOKEN }} |
||||
pr-message: 'Hello @${{ github.actor }}, thank you for submitting a PR! We will respond as soon as possible.' |
||||
issue-message: | |
||||
Hello @${{ github.actor }}, thank you for your interest in our work! |
||||
|
||||
If this is a bug report, please provide screenshots and **minimum viable code to reproduce your issue**, otherwise we can not help you. |
||||