Package: gda-score-code
codeThis repo holds a variety of tools in support of the GDA Score Project (General Data Anonymity Score Project).The code here is still very much alpha, and little effort has gone into making it easy for others to install and use.The primary language is Python, and requires Python3.7 or later. API documentation for some of the tools can be found athttps://gda-score.github.io/.To runInstalling viapip:step 0: Install prerequisites for "psycopg2" (https://www.psycopg.org/docs/install.html#build-prerequisites). For debian the command would beapt-get install python3-dev libpq-dev.step 1:$ pip install gda-score-codestep 2: Request passwords and user names fromcontact@gda-score.orgstep 3: if you would like to stick to default configuration then skip this step. otherwise try executing$ gdascore_initin your console  to modify the configuration.
This initiation script can also set required environment variables
(step 3) automatically.step 4: gdascore package needs the following environment variables as for database credentials
to work with Diffix and anonymization schemes that use the underlying postgres database at db001.gda-score.org. They are:GDA_SCORE_DIFFIX_USER:<diffix_user>GDA_SCORE_DIFFIX_PASS:<diffix_password>GDA_SCORE_RAW_USER:<postgres_user>GDA_SCORE_RAW_PASS:<postgres_password>step 5: use import statements such as the following in your code (see examples inattacksandutilityrepos):fromgdascore.gdaAttackimportgdaAttackfromgdascore.gdaScoreimportgdaScoresfromgdascore.gdaToolsimportsetupGdaAttackParametersfromgdascore.gdaQueryimport*How to update package on pipPlease follow the steps below if you are a contributor and want to upload new release of the library on pip.openpypi.organd create a new account if you don't have one.send us your username to be added as a maintainer of the package on pypi that lets you upload a new releaseinstall "twine" and "wheel" using:pip install twine wheelclean build files if there is any by running:python setup.py clean --alland also delete any folder nameddistas the setup will create that itself and you won't face vrsion confilict because of past builds anymore.update the version of package in the filesetup.pyand increase it. it is not possible to upload same version twice so remember to do that.nameparameter should not change (Note that there is also a gda-score-code-test package, which you can update just for testing purposes. Whichever you pip install last on your machine is the one that gets included). For example:setuptools.setup(  
    name="gda-score-code",  
    version="2.2.6", # increase it
    author="Paul Francis",
    ...
  )build the package:python setup.py sdist bdist_wheelupload to pypi:twine upload dist/*it will first ask for your username and password and then start uploading.note: you can always first upload the package into test.pypi.org instead of the main one to try installing it yourself and then upload to the main pypi repository. should you need to do that please refer to :https://packaging.python.org/guides/using-testpypi/DocumentationDocumentations for this project are being generated automatically out of "docStrings" available in the code.
We usepdoc3as a tool for that. Steps for updating documentation are as follows:install "pdoc3", "PyInquirer", and "pyfiglet":pip install pdoc3 PyInquirer pyfigletpopulate the code with docStrings in python modules, classes, functions, etc.on your terminalgo to project root folderand execute the command bellow:pdoc-o./docs--force--html--template-dir./docs/template--filtergdaScore,gdaAttack,gdaToolsgdascore-o ./docs: defines output directory--force: overrides current files in output directory--html: defines output format--template-dir ./docs/template: defines custom template directory that is used to generate output--filter gdaScore,gdaAttack,gdaTools: defines modules that has to be documented from the package. any other python file in the package will be ignored for documentation.gdascore: defines the name of package (directory)How to exclude certain part of code from documentationpdoc will by default include every piece of code that is "public" in the documentation. To avoid that, define a list on top of your module
and name it__all__and put the name of classes, functions, variables, etc. that you want to be documented in that list as strings.
for example:module.py__all__=["increase"]my_var=0defincrease():"""this function increases the value of 'my_var' by 1 and return it."""globalmy_varmy_var+=1returnmy_varNote that defining__all__will override things that gets imported when you usefrom module import *later.
However, you can have access to anything when you import them specifically likefrom module import my_varas well asimport module. It is generally recommended to avoidfrom module import *How to modify master html template for documentationTo modify the template that is used by pdoc for generating html formatted documentation, simply edit files under/docs/template:credits.makowill be included in the footer of every page.head.makowill be included in the<head>/<head>of every page. It is good for modifying css styles, title, etc. of the page.logo.makowill be included in logo placeholder (or simply header) of the page.In case you need to perform more modification to the template, please refer tooriginal pdoc documentation