Skip to content

Latest commit

 

History

History
53 lines (34 loc) · 1.68 KB

setup_dasea_tool.md

File metadata and controls

53 lines (34 loc) · 1.68 KB

Setup DaSEA tool

❗ Prerequisites

  • 🐍 Python >= 3.9, for example installed via pyenv
  • Poetry
  • Vagrant, see Vagrant installation file. For miners running in virtual machines, which are currently the ports and pkgsrc miners on BSDs, vagrant and VirtualBox have to be installed
  • To release the dataset, tar and bzip2 have to be installed and users need a Zenodo API token.

📚 Installation

After cloning the repository, run the following command:

poetry install

📝 Usage locally

For miners that do not require a VM, you can mine by running the following command:

poetry run dasea mine nameOfPackageManager

📝 Usage in Vagrant

Some ecosystem miners, e.g., those mining BSD ports and NetBSD pkgsrc have to be run on the respective BSD OS. Therefore, in these cases mining takes place in Virtualbox virtual machines that are managed with Vagrant. See our Vagrant installation file if you have not setup Vagrant yet.

Once setup, the available miners can be run by running the commands in the creade_dataset.sh

🤖 Available commands

All available miner commands can be found here

📄 Run formatter

poetry run black -l 120 --check ./dasea

🧪 Run tests

poetry run pytest tests

🆘 Add new dependency

poetry add dependency-name