Package: merged
MergedSimplify managing dependencies within an all-in-one TUI dashboard.How to use mergedYou will need to create a GITHUB_TOKEN with permissions viaGithub > Settings > Developer Settingswith therepopermissions to read public/private repositories and andadmin:orgforread:orgif you wish to access an organisation that is not public.pipinstallmerged# your github usernameexportGITHUB_USER="user"# an individual or an organisation in which the repository existsexportGITHUB_ORG="org"# a comma separated list of repositoriesexportGITHUB_REPOSITORY="repo_1,repo_2"# your personal github tokenexportGITHUB_TOKEN="secret"mergedcheckConfigurationMerged supports both .ini and .env files. Merged always searches for configuration in this order:Environment variables;Repository: ini or .env file;Configuration PathReview DefaultsThe following steps are used to provide the configuration using a.envor.inifile. The configuration can be read from within the module/repository (default location set by decouple) using the.envfile or via a location specified by an environmental variable that points to a.inifile located in the root of the project or in a location specified byPATH_TO_CONFIG.Using an.envfile within the repositorycd/home/<your-user>/workspace/apoclyps/merged
touch.envecho"GITHUB_ORG=apoclyps">>.envecho"GITHUB_REPOSITORY=micropython-by-example">>.envecho"GIT_BRANCH=main">>.env
python-mmergedconfigUsing an.inifile within the repositorycd/home/<your-user>/workspace/apoclyps/merged
touchsettings.iniecho"[settings]\nGITHUB_ORG=apoclyps\nGITHUB_REPOSITORY=micropython-by-example\nGIT_BRANCH=main">>settings.ini

python-mmergedconfigProviding a configuration pathIf you wish to set the configuration path to use aninior.envfile when running the application, you can use the configuration of a specific file by supplying the path to the configuration like so:cd/home/apoclyps/
touchsettings.iniecho"[settings]\nGITHUB_ORG=apoclyps\nGITHUB_REPOSITORY=micropython-by-example\nGIT_BRANCH=main">>settings.inicd/home/<your-user>/workspace/apoclyps/mergedexportMERGED_PATH_TO_CONFIG=/home/<your-user>/

python-mmergedconfigIf at any time, you want to confirm your configuration reflects the file you have provided, you can usemerged configto view what current configuration of Merged.Configuring LayoutGetting started with local developmentTo build and run the CLI on your host, you will need Python 3.9 or greater, pip, and virtualenv to build and runmerged.
If you wish to publish a PR with your changes, first create a fork on Github and clone that code.$ghrepocloneapoclyps/merged
$cdmerged
$python3-mvenvenv
$sourceenv/bin/activate(env)$pipinstall-rrequirements_dev.txt(env)$pipinstall-rrequirements.txt(env)$python-mmergedcheckIf you wish to keep a copy of Merged on your host system, you can install and run it using:python-mvenvenvsourceenv/bin/activate
python-mpipinstall-e.
merged-hYou can run the Merged within Docker:docker-composebuildcli&&docker-composerun--rmclipython-mmergedcheckTo build an image and run that image with all of the necessary dependencies using the following commands:docker-composebuildcli
docker-composerun--rmclipython-mmergedcheckTestingA test suite has been included to ensure Merged functions correctly.To run the entire test suite with verbose output, run the following:maketestLintingTo run individual linting steps:makelintYou can also set uppre-committo run the linting steps automatically during the commit phase,
the pre-commit pipeline can be set up by running the following command on the project root:pre-commitinstallTo run all checks manually:pre-commitrun--allContributionsPlease readCONTRIBUTING.mdfor details on our code of conduct, and the process for submitting pull requests to us.