Merge branch 'api'

ualberta-smr · Aug 3, 2024 · ac963fb · ac963fb
2 parents 4538c2a + 80b77cb
commit ac963fb
Show file tree

Hide file tree

Showing 146 changed files with 176 additions and 13,534 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,4 @@
+secrets.json
+dist/
+*.egg-info/
+.venv/
diff --git a/api/.idea/.gitignore → .idea/.gitignore b/api/.idea/.gitignore → .idea/.gitignore
diff --git a/.idea/PyMigBench.iml b/.idea/PyMigBench.iml
diff --git a/...ea/inspectionProfiles/Project_Default.xml → .idea/inspectionProfiles/Project_Default.xml b/...ea/inspectionProfiles/Project_Default.xml → .idea/inspectionProfiles/Project_Default.xml
diff --git a/.../inspectionProfiles/profiles_settings.xml → .../inspectionProfiles/profiles_settings.xml b/.../inspectionProfiles/profiles_settings.xml → .../inspectionProfiles/profiles_settings.xml
diff --git a/.idea/misc.xml b/.idea/misc.xml
diff --git a/api/.idea/modules.xml → .idea/modules.xml b/api/.idea/modules.xml → .idea/modules.xml
diff --git a/api/.idea/vcs.xml → .idea/vcs.xml b/api/.idea/vcs.xml → .idea/vcs.xml
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -0,0 +1,3 @@
+exclude pymigbench_tests/*
+exclude data/*
+include version
diff --git a/README.md b/README.md
@@ -1,7 +1,8 @@
 PyMigBench is a benchmark of Python Library Migrations. 
-This repository contains the data and code for the dataset.
+This repository contains the data and the code the library that can be used to access the dataset.
 
-## PyMigBench v2
+## Dataset
+### PyMigBench v2
 The current version, PyMigBench-2.0, includes 3,096 migration-related code changes from 335 migrations between 141 analogous library pairs.
 This includes all migrations from [PyMigBench v1](#pymigbench-v1) and additional migrations borrowed from the [SALM dataset](https://ieeexplore.ieee.org/document/10123560).
 The data also includes additional information per migration-related code change compared to v1.
@@ -15,7 +16,7 @@ Use either of these links to reproduce the paper.
 We may update this repository to correct any mistakes or add more data and it may not synch with the paper.
 For, the latest data, use the [latest release](https://github.com/ualberta-smr/PyMigBench/releases/latest) in this repository.
 
-## PyMigBench v1
+### PyMigBench v1
 We recommend using PyMigBench v2 for any new research.
 However, you want to use the v1 dataset, you should look at [Release 1.0.3](https://github.com/ualberta-smr/PyMigBench/releases/v1.0.3).
 Cite the paper below if you use the v1 dataset.
@@ -34,6 +35,50 @@ Cite the paper below if you use the v1 dataset.
 ```
 
 
+## Library
+
+### Installation
+The library and the dataset should be at the same version to be compatible.
+To install the library, run:
+```bash
+pip install pymigbench==<version>
+```
+
+### Basic usage
+To use the library, you need to have the dataset downloaded.
+You can download the dataset from the [GitHub repository](https://github.com/ualberta-smr/pymigbench).
+
+```python
+from pymigbench.database import Database
+from pathlib import Path
+
+yaml_root = Path('repo-root/migration/')
+
+db = Database.load_from_dir(yaml_root)  # Load the dataset from the directory
+migs = db.migs()  # Get all the migrations
+```
+
+### The constants
+There are several enums to help you work with the dataset:
+They are all in the `pymigbench.constants` module. Example: 
+```python
+from pymigbench.constants import ProgramElement
+```
+
+### The migration-related objects
+There are three main classes to encapsulate the data: `Migration`, `MigrationFile`, and `CodeChange`.
+
+`Migration` is the top level class representing one single migration, ie, one yaml file.
+`Migration` has a list of `MigrationFile` objects, which represent the files that were changed in the migration.
+`MigrationFile` has a list of `CodeChange` objects, which represent a single migration-related code change.
+Each of these model classes has an `id()` method that returns a unique identifier for the object across the full dataset.
+`CodeChange` object additionally has an `index` property and a `id_in_file()` method, which are unique within container file.
+Each of the classes has some additional helper methods.
+
+
+
+
+
 ## Contributors
 - [Mohayeminul Islam](https://mohayemin.github.io/)
 - [Ajay Kumar Jha](https://hifromajay.github.io/)

diff --git a/api/.gitignore b/api/.gitignore
diff --git a/api/.idea/.name b/api/.idea/.name
diff --git a/api/.idea/misc.xml b/api/.idea/misc.xml
diff --git a/api/.idea/pymigbench.api.iml b/api/.idea/pymigbench.api.iml
diff --git a/api/MANIFEST.in b/api/MANIFEST.in
diff --git a/api/build.sh b/api/build.sh
diff --git a/api/publish.sh b/api/publish.sh
diff --git a/code/.gitignore b/code/.gitignore
diff --git a/code/LICENSE b/code/LICENSE
diff --git a/code/configs/config.yaml b/code/configs/config.yaml
diff --git a/code/pymigstat/__init__.py b/code/pymigstat/__init__.py
diff --git a/code/pymigstat/code_change_search/__init__.py b/code/pymigstat/code_change_search/__init__.py