Package: clouding-server-manager
Clouding Server ManagerClouding Server Manager is a Python project that allows you to manage your Clouding servers from the command line. It is designed to list, archive, and unarchive servers in your Clouding account. It uses theClouding APIto perform the actions.Table of ContentsFeaturesExamplesInstallation with Poetry (recommended)Installation with pipInstallation as a PyPI packageDevelopment SetupContributingLicenseFeaturesSimple and easy to use command line interface.List all the information about your Clouding servers and filter their fields so that you can see only the information you want.Archive one or multiple servers at once.Unarchive one or multiple servers at once.ExamplesThese are just a few examples of how to use the script. For more information, check out the help message by runningpython -m clouding_server_manager --help.List all servers:python-mclouding_server_managerlist-tallList all servers and filter their fields:python-mclouding_server_managerlist-tall--fid-fnameArchive a server:python-mclouding_server_managerarchive-t123456Archive multiple servers:python-mclouding_server_managerarchive-t123456-t789012Unarchive a server:python-mclouding_server_managerunarchive-t123456Unarchive multiple servers:python-mclouding_server_managerunarchive-t123456-t789012Installation with Poetry (recommended)To set up the project, follow these steps:Make sure you havePoetryinstalled in your system.It is highly recommended to set this Poetry configuration parameters to avoid multiple issues:poetryconfigvirtualenvs.in-projecttruepoetryconfigvirtualenvs.prefer-active-pythontrueClone the repository:gitclonehttps://github.com/dmarts05/clouding-server-managerNavigate to the project directory:cdclouding-server-managerInstall the project dependencies using Poetry:poetryinstallYou might needpyenvto install the Python version specified in thepyproject.tomlfile. If that's the case, runpyenv install 3.9before running the previous command. Also, check out thePoetry documentation about pyenvfor more information.Activate the virtual environment:poetryshellThis will activate the virtual environment so that you can run the script.Enter your Clouding API key in the.envfile. Check out.env.samplefor an example. You can find your Clouding API key in the API section of your Clouding account (as of now you need access to the beta version of the Clouding API). As an alternative, you can use --api-key or -k to specify your API key when running the script.Run the script:python-mclouding_server_manager--helporpoetryrunclouding-sm--helpThis will display the help message and show you how to use the script.Installation with pipThis is an alternative installation method that uses pip instead of Poetry. It might not work as expected, so it is recommended to use the Poetry installation method instead. To set up the project, follow these steps:Clone the repository:gitclonehttps://github.com/dmarts05/clouding-server-managerNavigate to the project directory:cdclouding-server-managerInstall the project dependencies using pip:pipinstall-rrequirements.txtYou might needpyenvto install the Python version specified in therequirements.txtfile.Enter your Clouding API key in the.envfile. Check out.env.samplefor an example. You can find your Clouding API key in the API section of your Clouding account (as of now you need access to the beta version of the Clouding API). As an alternative, you can use --api-key or -k to specify your API key when running the script.Run the script:python-mclouding_server_manager--helporpoetryrunclouding-sm--helpThis will display the help message and show you how to use the script.Installation as a PyPI packageThis is an alternative installation method that uses pip to install the package from PyPI. It might not work as expected, so it is recommended to use the Poetry installation method instead. To set up the project, follow these steps:Install the package using pip:pipinstallclouding-server-managerConfigure the environment variable withexportor by adding them to your.bashrcor.zshrcfile:exportCLOUDING_API_KEY="YOUR API KEY"You can find your Clouding API key in the API section of your Clouding account (as of now you need access to the beta version of the Clouding API). As an alternative, you can use --api-key or -k to specify your API key when running the script.Run the script:clouding-sm--helpThis will display the help message and show you how to use the script.Development SetupIf you want to contribute to the project or run the development environment, follow these additional steps:Install the development dependencies:poetryinstall--withdevInstall pre-commit hooks:poetryrunpre-commitinstallFormat the code:poetryrunblackclouding_server_managerLint the code:poetryrunflake8clouding_server_managerRun static type checking:poetryrunmypyclouding_server_managerGenerate the documentation:cddocs&&poetryrunmakehtmlDo everything at once (except for generating the documentation):poetryrunpre-commitrun--all-filesThat's it! You now have the project set up and ready for development or execution.ContributingPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.LicenseThis project is licensed under theMIT License. See theLICENSEfile for details.