Rename main package

LadyChristina · dimkarakostas · commit 2e09b056b3a9 · 2023-08-24T16:39:17.000+03:00
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -33,8 +33,8 @@ All Submissions:
     - [ ] EthereumMapping
     - [ ] CardanoMapping
     - [ ] TezosMapping
-- [ ] Did you enable the parser for the new ledger in `src/parse.py`?
-- [ ] Did you enable the mapping for the new ledger in `src/map.py`?
+- [ ] Did you enable the parser for the new ledger in `consensus_decentralization/parse.py`?
+- [ ] Did you enable the mapping for the new ledger in `consensus_decentralization/map.py`?
 - [ ] Did you document support for the new ledger as described in our [Contributing documentation](https://blockchain-technology-lab.github.io/consensus-decentralization/contribute)?
 
 ### Update Mapping Support Information Submissions:
@@ -50,9 +50,9 @@ All Submissions:
 
 ### New Metric Support Submissions:
 
-- [ ] Did you put the metric's script under `src/metrics`?
+- [ ] Did you put the metric's script under `consensus_decentralization/metrics`?
 - [ ] Did you name the metric's main function of the script `compute_{metric name}`?
-- [ ] Did you import the metric's main function to `src/analyze.py`?
+- [ ] Did you import the metric's main function to `consensus_decentralization/analyze.py`?
 - [ ] Did you add the new metric (and possible parameter values) to `config.yaml`?
 - [ ] Did you write unit tests for the new metric?
 - [ ] Did you document the new metric in the documentation pages?
diff --git a/consensus_decentralization/__init__.py b/consensus_decentralization/__init__.py
diff --git a/consensus_decentralization/analyze.py b/consensus_decentralization/analyze.py
@@ -1,11 +1,11 @@
 import argparse
 import logging
 from collections import defaultdict
-from src.metrics.gini import compute_gini  # noqa: F401
-from src.metrics.nakamoto_coefficient import compute_nakamoto_coefficient  # noqa: F401
-from src.metrics.entropy import compute_entropy, compute_entropy_percentage  # noqa: F401
-from src.metrics.herfindahl_hirschman_index import compute_hhi  # noqa: F401
-from src.helper import OUTPUT_DIR, get_metrics_config, get_start_end_years
+from consensus_decentralization.metrics.gini import compute_gini  # noqa: F401
+from consensus_decentralization.metrics.nakamoto_coefficient import compute_nakamoto_coefficient  # noqa: F401
+from consensus_decentralization.metrics.entropy import compute_entropy, compute_entropy_percentage  # noqa: F401
+from consensus_decentralization.metrics.herfindahl_hirschman_index import compute_hhi  # noqa: F401
+from consensus_decentralization.helper import OUTPUT_DIR, get_metrics_config, get_start_end_years
 
 
 def analyze(projects, timeframes, output_dir):
diff --git a/consensus_decentralization/collect_data.py b/consensus_decentralization/collect_data.py
@@ -13,7 +13,7 @@
 import logging
 from yaml import safe_load
 
-from src.helper import ROOT_DIR, RAW_DATA_DIR
+from consensus_decentralization.helper import ROOT_DIR, RAW_DATA_DIR
 
 
 def collect_data(force_query):
diff --git a/consensus_decentralization/helper.py b/consensus_decentralization/helper.py
diff --git a/consensus_decentralization/map.py b/consensus_decentralization/map.py
@@ -1,10 +1,10 @@
 import argparse
 import logging
-from src.mappings.default_mapping import DefaultMapping
-from src.mappings.ethereum_mapping import EthereumMapping
-from src.mappings.cardano_mapping import CardanoMapping
-from src.mappings.tezos_mapping import TezosMapping
-from src.helper import OUTPUT_DIR, get_start_end_years
+from consensus_decentralization.mappings.default_mapping import DefaultMapping
+from consensus_decentralization.mappings.ethereum_mapping import EthereumMapping
+from consensus_decentralization.mappings.cardano_mapping import CardanoMapping
+from consensus_decentralization.mappings.tezos_mapping import TezosMapping
+from consensus_decentralization.helper import OUTPUT_DIR, get_start_end_years
 
 ledger_mapping = {
     'bitcoin': DefaultMapping,
diff --git a/consensus_decentralization/mappings/cardano_mapping.py b/consensus_decentralization/mappings/cardano_mapping.py
@@ -1,6 +1,6 @@
 from collections import defaultdict
-from src.mappings.default_mapping import DefaultMapping
-import src.helper as hlp
+from consensus_decentralization.mappings.default_mapping import DefaultMapping
+import consensus_decentralization.helper as hlp
 
 
 class CardanoMapping(DefaultMapping):
diff --git a/consensus_decentralization/mappings/default_mapping.py b/consensus_decentralization/mappings/default_mapping.py
@@ -1,6 +1,6 @@
 from collections import defaultdict
 import json
-import src.helper as hlp
+import consensus_decentralization.helper as hlp
 
 
 class DefaultMapping:
diff --git a/consensus_decentralization/mappings/dummy_mapping.py b/consensus_decentralization/mappings/dummy_mapping.py
@@ -1,6 +1,6 @@
 from collections import defaultdict
-from src.helper import write_blocks_per_entity_to_file
-from src.mappings.default_mapping import DefaultMapping
+from consensus_decentralization.helper import write_blocks_per_entity_to_file
+from consensus_decentralization.mappings.default_mapping import DefaultMapping
 
 
 class DummyMapping(DefaultMapping):
diff --git a/consensus_decentralization/mappings/ethereum_mapping.py b/consensus_decentralization/mappings/ethereum_mapping.py
@@ -1,4 +1,4 @@
-from src.mappings.default_mapping import DefaultMapping
+from consensus_decentralization.mappings.default_mapping import DefaultMapping
 
 
 class EthereumMapping(DefaultMapping):
diff --git a/consensus_decentralization/mappings/tezos_mapping.py b/consensus_decentralization/mappings/tezos_mapping.py
@@ -1,4 +1,4 @@
-from src.mappings.default_mapping import DefaultMapping
+from consensus_decentralization.mappings.default_mapping import DefaultMapping
 
 
 class TezosMapping(DefaultMapping):
diff --git a/consensus_decentralization/metrics/entropy.py b/consensus_decentralization/metrics/entropy.py
@@ -1,7 +1,7 @@
 import logging
 from math import log
 import sys
-import src.helper as hlp
+import consensus_decentralization.helper as hlp
 
 
 def compute_entropy(blocks_per_entity, alpha):
diff --git a/consensus_decentralization/metrics/gini.py b/consensus_decentralization/metrics/gini.py
@@ -1,7 +1,7 @@
 import logging
 import numpy as np
 import sys
-import src.helper as hlp
+import consensus_decentralization.helper as hlp
 
 
 def compute_gini(blocks_per_entity):
diff --git a/consensus_decentralization/metrics/herfindahl_hirschman_index.py b/consensus_decentralization/metrics/herfindahl_hirschman_index.py
@@ -1,6 +1,6 @@
 import logging
 import sys
-import src.helper as hlp
+import consensus_decentralization.helper as hlp
 
 
 def compute_hhi(blocks_per_entity):
diff --git a/consensus_decentralization/metrics/nakamoto_coefficient.py b/consensus_decentralization/metrics/nakamoto_coefficient.py
@@ -1,6 +1,6 @@
 import logging
 import sys
-import src.helper as hlp
+import consensus_decentralization.helper as hlp
 
 
 def compute_nakamoto_coefficient(blocks_per_entity):
diff --git a/consensus_decentralization/parse.py b/consensus_decentralization/parse.py
@@ -1,9 +1,9 @@
 import argparse
 import logging
-from src.parsers.default_parser import DefaultParser
-from src.parsers.dummy_parser import DummyParser
-from src.parsers.ethereum_parser import EthereumParser
-from src.helper import RAW_DATA_DIR, OUTPUT_DIR
+from consensus_decentralization.parsers.default_parser import DefaultParser
+from consensus_decentralization.parsers.dummy_parser import DummyParser
+from consensus_decentralization.parsers.ethereum_parser import EthereumParser
+from consensus_decentralization.helper import RAW_DATA_DIR, OUTPUT_DIR
 
 
 ledger_parser = {
diff --git a/consensus_decentralization/parsers/default_parser.py b/consensus_decentralization/parsers/default_parser.py
diff --git a/consensus_decentralization/parsers/dummy_parser.py b/consensus_decentralization/parsers/dummy_parser.py
@@ -1,4 +1,4 @@
-from src.parsers.default_parser import DefaultParser
+from consensus_decentralization.parsers.default_parser import DefaultParser
 
 
 class DummyParser(DefaultParser):
diff --git a/consensus_decentralization/parsers/ethereum_parser.py b/consensus_decentralization/parsers/ethereum_parser.py
@@ -1,4 +1,4 @@
-from src.parsers.dummy_parser import DummyParser
+from consensus_decentralization.parsers.dummy_parser import DummyParser
 
 
 class EthereumParser(DummyParser):
diff --git a/consensus_decentralization/plot.py b/consensus_decentralization/plot.py
@@ -5,7 +5,7 @@
 import seaborn as sns
 import numpy as np
 from collections import defaultdict
-import src.helper as hlp
+import consensus_decentralization.helper as hlp
 import heapq
 import colorcet as cc
 import pandas as pd
diff --git a/docs/contribute.md b/docs/contribute.md
@@ -19,14 +19,14 @@ documentation](https://blockchain-technology-lab.github.io/consensus-decentraliz
 
 ### Parser and mapping
 
-In the directory `src/parsers`, create a file named `<project_name>_parser.py`,
+In the directory `consensus_decentralization/parsers`, create a file named `<project_name>_parser.py`,
 if no existing parser can be reused. In this file create a new class, which
 inherits from the `DefaultParser` class of `default_parser.py`. Then,
 override its `parse` method in order to implement the new parser (or override another
 method if there are only small changes needed, e.g. `parse_identifiers` if the only thing
 that is different from the default parser is the way identifiers are decoded).
 
-In the directory `src/mappings`, create a file named
+In the directory `consensus_decentralization/mappings`, create a file named
 `<project_name>_mapping.py`, if no existing mapping can be reused. In this file
 create a new class, which inherits from the `DefaultMapping` class of `default_mapping.py`.
 Then, override its `process` method. This method takes as input a time period in
@@ -38,9 +38,9 @@ data for this timeframe in the `output` directory.
 Then, you should enable support for the new ledger in the parser and mapping
 module scripts. Specifically:
 
-- in the script `src/parse.py`, import the parser class and assign it to the
+- in the script `consensus_decentralization/parse.py`, import the parser class and assign it to the
   project's name in the `ledger_parser` dictionary;
-- in the script `src/map.py`, import the mapping class and assign it to the
+- in the script `consensus_decentralization/map.py`, import the mapping class and assign it to the
   project's name in the dictionary `ledger_mapping`.
 
 *Notes*:
@@ -104,12 +104,12 @@ available on-chain. Specifically:
 
 To add a new metric, you should do the following steps.
 
-First, create a relevant script in the folder `src/metrics`. The script should
+First, create a relevant script in the folder `consensus_decentralization/metrics`. The script should
 include a function named `compute_{metric_name}` that, given a dictionary of
 entities (as keys) to number of blocks (as values), outputs a single value (the
 outcome of the metric).
 
-Second, import this new function to `src/analyze.py`.
+Second, import this new function to `consensus_decentralization/analyze.py`.
 
 Third, add the name of the metric (which should be the same as the one used in
 the filename above) and any parameter values it might require to the file
diff --git a/docs/data.md b/docs/data.md
@@ -97,7 +97,7 @@ ORDER BY timestamp
 
 Instead of executing each of these queries separately on the BigQuery console and saving the results manually, it is
 also possible to automate the process using
-a [script](https://github.com/Blockchain-Technology-Lab/consensus-decentralization/blob/main/src/collect_data.py) and collect all
+a [script](https://github.com/Blockchain-Technology-Lab/consensus-decentralization/blob/main/consensus_decentralization/collect_data.py) and collect all
 relevant data in one go. Executing this script will run all queries
 in [this file](https://github.com/Blockchain-Technology-Lab/consensus-decentralization/blob/main/queries.yaml), so you can also
 control which queries are run by adding them to or removing them from the file (or turning them into comments by 
@@ -111,7 +111,7 @@ root directory of the project under the name 'google-service-account-key.json'.
 that you can consult, which shows what your credentials are supposed to look like (but note that this is for
 informational purposes only, this file is not used in the code).
 
-Once you have set up the credentials, you can just run the following command from the `src` directory to retrieve data
+Once you have set up the credentials, you can just run the following command from the `consensus_decentralization` directory to retrieve data
 for all supported blockchains:
 
 `python collect_data.py`
diff --git a/run.py b/run.py
@@ -1,10 +1,10 @@
 import argparse
 import logging
-from src.map import apply_mapping
-from src.analyze import analyze
-from src.parse import parse
-from src.plot import plot
-from src.helper import valid_date, RAW_DATA_DIR, OUTPUT_DIR, get_default_ledgers, get_start_end_years
+from consensus_decentralization.map import apply_mapping
+from consensus_decentralization.analyze import analyze
+from consensus_decentralization.parse import parse
+from consensus_decentralization.plot import plot
+from consensus_decentralization.helper import valid_date, RAW_DATA_DIR, OUTPUT_DIR, get_default_ledgers, get_start_end_years
 
 logging.basicConfig(format='[%(asctime)s] %(message)s', datefmt='%Y/%m/%d %I:%M:%S %p', level=logging.INFO)
 
diff --git a/tests/test_1_setup.py b/tests/test_1_setup.py
@@ -1,5 +1,5 @@
-from src.map import ledger_mapping
-from src.parse import ledger_parser
+from consensus_decentralization.map import ledger_mapping
+from consensus_decentralization.parse import ledger_parser
 
 
 def test_project_dicts():
diff --git a/tests/test_2_helper.py b/tests/test_2_helper.py
@@ -3,10 +3,10 @@
 import os
 import shutil
 import pytest
-from src.helper import get_known_entities, get_pool_identifiers, get_pool_links, get_known_addresses, write_blocks_per_entity_to_file, \
+from consensus_decentralization.helper import get_known_entities, get_pool_identifiers, get_pool_links, get_known_addresses, write_blocks_per_entity_to_file, \
     get_blocks_per_entity_from_file, get_blocks_per_entity_group_from_file, get_timeframe_beginning, \
     get_timeframe_end, get_time_period, get_default_ledgers, valid_date, OUTPUT_DIR
-from src.map import ledger_mapping
+from consensus_decentralization.map import ledger_mapping
 
 
 @pytest.fixture
diff --git a/tests/test_2_metrics.py b/tests/test_2_metrics.py
@@ -1,4 +1,4 @@
-from src.metrics import entropy, gini, nakamoto_coefficient, herfindahl_hirschman_index
+from consensus_decentralization.metrics import entropy, gini, nakamoto_coefficient, herfindahl_hirschman_index
 import numpy as np
 
 
diff --git a/tests/test_3_parsers.py b/tests/test_3_parsers.py
@@ -1,10 +1,10 @@
 import json
 import shutil
 import pytest
-from src.parse import parse, ledger_parser
-from src.parsers.default_parser import DefaultParser
-from src.parsers.dummy_parser import DummyParser
-from src.helper import RAW_DATA_DIR, OUTPUT_DIR
+from consensus_decentralization.parse import parse, ledger_parser
+from consensus_decentralization.parsers.default_parser import DefaultParser
+from consensus_decentralization.parsers.dummy_parser import DummyParser
+from consensus_decentralization.helper import RAW_DATA_DIR, OUTPUT_DIR
 
 
 @pytest.fixture
diff --git a/tests/test_4_mappings.py b/tests/test_4_mappings.py
@@ -3,16 +3,16 @@
 import shutil
 import os
 import json
-from src.parse import parse, ledger_parser
-from src.parsers.default_parser import DefaultParser
-from src.parsers.dummy_parser import DummyParser
-from src.parsers.ethereum_parser import EthereumParser
-from src.map import apply_mapping, ledger_mapping
-from src.mappings.default_mapping import DefaultMapping
-from src.mappings.ethereum_mapping import EthereumMapping
-from src.mappings.cardano_mapping import CardanoMapping
-from src.mappings.tezos_mapping import TezosMapping
-from src.helper import RAW_DATA_DIR, OUTPUT_DIR
+from consensus_decentralization.parse import parse, ledger_parser
+from consensus_decentralization.parsers.default_parser import DefaultParser
+from consensus_decentralization.parsers.dummy_parser import DummyParser
+from consensus_decentralization.parsers.ethereum_parser import EthereumParser
+from consensus_decentralization.map import apply_mapping, ledger_mapping
+from consensus_decentralization.mappings.default_mapping import DefaultMapping
+from consensus_decentralization.mappings.ethereum_mapping import EthereumMapping
+from consensus_decentralization.mappings.cardano_mapping import CardanoMapping
+from consensus_decentralization.mappings.tezos_mapping import TezosMapping
+from consensus_decentralization.helper import RAW_DATA_DIR, OUTPUT_DIR
 
 
 @pytest.fixture
diff --git a/tests/test_5_analyze.py b/tests/test_5_analyze.py
@@ -1,8 +1,8 @@
 import os
 import shutil
 import pytest
-from src.helper import OUTPUT_DIR
-from src.analyze import analyze
+from consensus_decentralization.helper import OUTPUT_DIR
+from consensus_decentralization.analyze import analyze
 
 
 @pytest.fixture
diff --git a/tests/test_6_end_to_end.py b/tests/test_6_end_to_end.py
@@ -2,13 +2,13 @@
 import pathlib
 import shutil
 from run import main
-from src.parse import ledger_parser
-from src.parsers.default_parser import DefaultParser
-from src.parsers.dummy_parser import DummyParser
-from src.map import ledger_mapping
-from src.mappings.default_mapping import DefaultMapping
-from src.mappings.cardano_mapping import CardanoMapping
-from src.helper import OUTPUT_DIR
+from consensus_decentralization.parse import ledger_parser
+from consensus_decentralization.parsers.default_parser import DefaultParser
+from consensus_decentralization.parsers.dummy_parser import DummyParser
+from consensus_decentralization.map import ledger_mapping
+from consensus_decentralization.mappings.default_mapping import DefaultMapping
+from consensus_decentralization.mappings.cardano_mapping import CardanoMapping
+from consensus_decentralization.helper import OUTPUT_DIR
 import pytest
 
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-from src.mappings.default_mapping import DefaultMapping`
	`1`	`+from consensus_decentralization.mappings.default_mapping import DefaultMapping`
`2`	`2`
`3`	`3`
`4`	`4`	`class EthereumMapping(DefaultMapping):`