yhay81 / socialname Goto Github PK

• Users can easily install socialname and know how to use it at a glance of README.md.
• Contributors can easily know how to contribute, report issue, and make PR.
• Developers can easily know how to start developing.
• Developers can easily know how to add/delete/fix social site.
• Developers can easily know how to write logic module.
• Rewrite contents under /.github for contributors.

Checklist

• I'm asking a question regarding socialname
• My question is not a tech support question.

We are not your tech support.
If you have questions related to pip, git, or something that is not related to Sherlock, please ask them on StackOverflow or r/learnpython

Question

The sherlock project is almost a year ahead in developement. Will this project get updated or is there an alternative you could recommend?

• Use mkdocs-material https://squidfunk.github.io/mkdocs-material/
• The site is served on GitHub pages
• Almost all resources for document site is under /docs
• Publishing command is in Makefile

• Create Open Source Web API for socialname as another repo
• Mostly from socialpedia https://socialpedia.net/
• Backend API use sqlite3 as default, but can use any RDB supported by SQLAlchemy
• Backend API, Frontend app, and DataBase(MySQL?) can run on docker-compose.

• Use GitHub Actions.
• Run on every PR.
• Restriction that to merge PR it needs green.

• Use Google Style https://google.github.io/styleguide/pyguide.html
• Write Module Docstring
• Write Class Docstring
• Write Function Docstring

• Use pytest
• Write End to End test.
• Write tests which can check usernameClaimed and usernameUnclaimed returns correct result for all sites.
• Write failure test for each request logic when request failed in any reason.
• Write Unit test.
• Write validation check of data.json.