Skip to content

INSTALL.md

Latest commit

 

History

History
34 lines (21 loc) · 1.41 KB

INSTALL.md

File metadata and controls

34 lines (21 loc) · 1.41 KB

Install tips

Prepare repository

Clone repo locally and use prepare.py script to prepare repo code for using in another project.

You should run the script to rename dirs and variables in py-files.

Also you can clean all useless files this way:

$ make clean

Update main code

You should edit file osint_cli_tool_skeleton/core.py to use you OSINT methods / calls / etc. instead of template method (get title and status code from main page of site).

InputData - usually it is not necessary to change, just a value for search for.

OutputData - class with result fields, you must change it for your own purposes.

Processor -> def request - function for converting input to output, you must write your own logic there.

PyPI publishing

To prepare repo for the publishing:

  1. Register (if you not)
  2. Add your login and password to the repo secrets (Settings => Secrets) as PYPI_PASSWORD and PYPI_USERNAME

To publish package to the PyPI registry:

  1. Update your package version in the _version file
  2. Create a release with the button Draft a new release

A new publish action should be started, you can check it in your repo's Actions section