diff --git a/database/__init__.py b/database/__init__.py index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..705b9c6232efd4d7d859e11e87c83cc4c32da0f4 100644 --- a/database/__init__.py +++ b/database/__init__.py @@ -0,0 +1,21 @@ +""" +Copyright (C) 2018 Centro de Computacao Cientifica e Software Livre +Departamento de Informatica - Universidade Federal do Parana - C3SL/UFPR + +This file is part of HOTMapper. + +HOTMapper is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +HOTMapper is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with simcaq-cdn. If not, see <https://www.gnu.org/licenses/>. + +""" + diff --git a/database/actions.py b/database/actions.py index 06c676a9b341d58af133c52abe8938b03a5578b4..9ba4c3876ff585155b8e29640e76965e216befcf 100644 --- a/database/actions.py +++ b/database/actions.py @@ -1,3 +1,24 @@ +""" +Copyright (C) 2018 Centro de Computacao Cientifica e Software Livre +Departamento de Informatica - Universidade Federal do Parana - C3SL/UFPR + +This file is part of HOTMapper. + +HOTMapper is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +HOTMapper is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with simcaq-cdn. If not, see <https://www.gnu.org/licenses/>. + +""" + '''Database manipulation actions - these can be used as models for other modules.''' import logging from sqlalchemy import create_engine, MetaData diff --git a/database/base.py b/database/base.py index 5ec22f23b88fc8365969f9a65a6ae9b5104480c0..d00aa5b4aa71e97da9681797777c20d5e2017cc1 100644 --- a/database/base.py +++ b/database/base.py @@ -1,3 +1,24 @@ +""" +Copyright (C) 2018 Centro de Computacao Cientifica e Software Livre +Departamento de Informatica - Universidade Federal do Parana - C3SL/UFPR + +This file is part of HOTMapper. + +HOTMapper is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +HOTMapper is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with simcaq-cdn. If not, see <https://www.gnu.org/licenses/>. + +""" + '''Module containing base declarations''' diff --git a/database/database_table.py b/database/database_table.py index 7cb205d54fad6512883cfc2251cf5aa5cf1a1d90..ef3d809acdd1e80a9b796407f9399ece9b9c37c5 100644 --- a/database/database_table.py +++ b/database/database_table.py @@ -1,3 +1,24 @@ +""" +Copyright (C) 2018 Centro de Computacao Cientifica e Software Livre +Departamento de Informatica - Universidade Federal do Parana - C3SL/UFPR + +This file is part of HOTMapper. + +HOTMapper is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +HOTMapper is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with simcaq-cdn. If not, see <https://www.gnu.org/licenses/>. + +""" + '''This module contains the definition of the DatabaseTable class and a constructor''' import os import time diff --git a/database/protocol.py b/database/protocol.py index f09c6197b0ef6e35b52c9db8dd21420949f9b89a..d78edf963b588a2b24d4805c7d4cfd82474b54e2 100644 --- a/database/protocol.py +++ b/database/protocol.py @@ -1,3 +1,24 @@ +""" +Copyright (C) 2018 Centro de Computacao Cientifica e Software Livre +Departamento de Informatica - Universidade Federal do Parana - C3SL/UFPR + +This file is part of HOTMapper. + +HOTMapper is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +HOTMapper is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with simcaq-cdn. If not, see <https://www.gnu.org/licenses/>. + +""" + ''' Routines related to column dictionary generation. Names comonly used: - original columns: columns as they are named in the original database; diff --git a/database/types.py b/database/types.py index 61b6987cf8b7bc8623828a93adc0444c9ab5f96b..1f0b24a7593e1d8d6ba5c766865e8227027b9018 100644 --- a/database/types.py +++ b/database/types.py @@ -1,3 +1,24 @@ +""" +Copyright (C) 2018 Centro de Computacao Cientifica e Software Livre +Departamento de Informatica - Universidade Federal do Parana - C3SL/UFPR + +This file is part of HOTMapper. + +HOTMapper is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +HOTMapper is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with simcaq-cdn. If not, see <https://www.gnu.org/licenses/>. + +""" + import re from sqlalchemy_monetdb.types import MONETDB_TYPE_MAP, TINYINT, DOUBLE_PRECISION from sqlalchemy.ext.compiler import compiles diff --git a/generate_schema.py b/generate_schema.py index 53f1d05fea62e324af3b59ae7ea23fc81f3c554f..ab990c2ae2956fe4bae1b0b20f620c96aade9c5d 100644 --- a/generate_schema.py +++ b/generate_schema.py @@ -1,3 +1,24 @@ +""" +Copyright (C) 2018 Centro de Computacao Cientifica e Software Livre +Departamento de Informatica - Universidade Federal do Parana - C3SL/UFPR + +This file is part of HOTMapper. + +HOTMapper is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +HOTMapper is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with simcaq-cdn. If not, see <https://www.gnu.org/licenses/>. + +""" + '''Generates schema in mysql dialect. Useful for documentation''' from sqlalchemy import create_engine, MetaData, inspect from sqlalchemy.dialects import mysql diff --git a/manage.py b/manage.py index ececfdc17d73a135e44ef28e13718e2b92f1cb08..a4dba5084866b5f6d2e27e04e196f3156f831536 100755 --- a/manage.py +++ b/manage.py @@ -1,4 +1,28 @@ #!/usr/bin/env python3 + +""" +Copyright (C) 2018 Centro de Computacao Cientifica e Software Livre +Departamento de Informatica - Universidade Federal do Parana - C3SL/UFPR + +This file is part of HOTMapper. + +HOTMapper is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +HOTMapper is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with simcaq-cdn. If not, see <https://www.gnu.org/licenses/>. + +""" + + + '''CLI for database module''' from manager import Manager diff --git a/mapping_functions/__init__.py b/mapping_functions/__init__.py index 9f17110fc6bc945861940d1eebc239d7906822d1..36f5b730e01e6cde511a40fa8cce38d091a53ba2 100644 --- a/mapping_functions/__init__.py +++ b/mapping_functions/__init__.py @@ -1,3 +1,24 @@ +""" +Copyright (C) 2018 Centro de Computacao Cientifica e Software Livre +Departamento de Informatica - Universidade Federal do Parana - C3SL/UFPR + +This file is part of HOTMapper. + +HOTMapper is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +HOTMapper is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with simcaq-cdn. If not, see <https://www.gnu.org/licenses/>. + +""" + ''' This module contains functions to generate pairing reports ''' import os import pandas as pd diff --git a/mapping_functions/table_manipulation.py b/mapping_functions/table_manipulation.py index 80de3fae35b2cccb83938f6b6afe951bace93128..9cb106bffe34a65391d41d4043d65350d201bc6a 100644 --- a/mapping_functions/table_manipulation.py +++ b/mapping_functions/table_manipulation.py @@ -1,3 +1,24 @@ +""" +Copyright (C) 2018 Centro de Computacao Cientifica e Software Livre +Departamento de Informatica - Universidade Federal do Parana - C3SL/UFPR + +This file is part of HOTMapper. + +HOTMapper is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +HOTMapper is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with simcaq-cdn. If not, see <https://www.gnu.org/licenses/>. + +""" + '''Defines functions to build the pairing reports, without concern for specific type output''' import os import numpy as np diff --git a/pnad_protocol_from_dic.py b/pnad_protocol_from_dic.py index 517a8885631b5011f43c066a0a3d56440471eaa7..4879ce7565497097af3ed90f1488aa09b3b605e9 100644 --- a/pnad_protocol_from_dic.py +++ b/pnad_protocol_from_dic.py @@ -1,3 +1,25 @@ +""" +Copyright (C) 2018 Centro de Computacao Cientifica e Software Livre +Departamento de Informatica - Universidade Federal do Parana - C3SL/UFPR + +This file is part of HOTMapper. + +HOTMapper is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +HOTMapper is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with simcaq-cdn. If not, see <https://www.gnu.org/licenses/>. + +""" + + import sys import pandas as pd diff --git a/protocols_comparison.py b/protocols_comparison.py index cf6fd3be85bd534b86d79edb5e22e85a3700ea14..661d24e0d98a10e8c094541e2b5c5ecbb443be6a 100644 --- a/protocols_comparison.py +++ b/protocols_comparison.py @@ -1,3 +1,24 @@ +""" +Copyright (C) 2018 Centro de Computacao Cientifica e Software Livre +Departamento de Informatica - Universidade Federal do Parana - C3SL/UFPR + +This file is part of HOTMapper. + +HOTMapper is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +HOTMapper is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with simcaq-cdn. If not, see <https://www.gnu.org/licenses/>. + +""" + import pandas as pd import os diff --git a/settings.py b/settings.py index fd664c9b6044f660d43ebba647849fcb59d715c9..94ca902077f8f1103f92e1a77d43967188fcc066 100644 --- a/settings.py +++ b/settings.py @@ -1,3 +1,25 @@ +""" +Copyright (C) 2018 Centro de Computacao Cientifica e Software Livre +Departamento de Informatica - Universidade Federal do Parana - C3SL/UFPR + +This file is part of HOTMapper. + +HOTMapper is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +HOTMapper is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with simcaq-cdn. If not, see <https://www.gnu.org/licenses/>. + +""" + + '''Settings used by the database module''' import logging diff --git a/tests/__init__.py b/tests/__init__.py index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..705b9c6232efd4d7d859e11e87c83cc4c32da0f4 100644 --- a/tests/__init__.py +++ b/tests/__init__.py @@ -0,0 +1,21 @@ +""" +Copyright (C) 2018 Centro de Computacao Cientifica e Software Livre +Departamento de Informatica - Universidade Federal do Parana - C3SL/UFPR + +This file is part of HOTMapper. + +HOTMapper is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +HOTMapper is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with simcaq-cdn. If not, see <https://www.gnu.org/licenses/>. + +""" + diff --git a/tests/database_table_test.py b/tests/database_table_test.py index aabe54caf9c96fa1e396b54e2d3543531320a47c..e06c5864facc41b9ff29fd331dad5d92cbf501f9 100644 --- a/tests/database_table_test.py +++ b/tests/database_table_test.py @@ -1,4 +1,26 @@ #!/usr/bin/env python3 + +""" +Copyright (C) 2018 Centro de Computacao Cientifica e Software Livre +Departamento de Informatica - Universidade Federal do Parana - C3SL/UFPR + +This file is part of HOTMapper. + +HOTMapper is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +HOTMapper is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with simcaq-cdn. If not, see <https://www.gnu.org/licenses/>. + +""" + '''Describes tests for the database.database_table module, concerning DatabaseTable objects and their manipulation''' import unittest