Skip to main content

Package that creates simple APIs to interact with Jfrog

Project description

Contributors Forks Stargazers Issues MIT License

Bugs Code Smells Code Coverage Lines of Code Duplicated Lines Vulnerabilities

Quality Gate Status Maintainability Rating Reliability Rating Security Rating


JFrog Client

API Calls to interact with Jfrog
Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

This project is collection of API calls that interact with the Jfrog Platform to help maintain daily operations such as checking the health, getting current version, getting storage usage, user details, create repos etc.

(back to top)

Built With

Python

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • python

Installation

  1. Clone the repo
    git clone https://github.com/peterdeames/jfrog-client.git
    
  2. Install Python packages
    pip install -r requirements.txt
    

(back to top)

Roadmap

  • Platform
    • Get Count of Users
    • Generate Token
    • Get Tokens
    • Get Default Token Expiry
    • Set Default Expiry
  • Artifactory
    • Ping Artifactory Instance
    • Get Artifactory Version
    • Get Artifactory Licence Details
    • Get Count of Repositories
    • Rename Repository
  • Mission Control
    • Ping Mission Control Instance
  • Xray
    • Ping Xray Instance
    • Get Xray Version
  • Migration
    • Setup and Migrate Local Repos
    • Setup Remote Repos
    • Setup Virtual Repos
    • Setup Groups
    • Setup Permissions
    • Setup Projects
    • Report the repos differences between 2 JFP Instances
    • Report the group differences between 2 JFP Instances
    • Report the permission differences between 2 JFP Instances
    • Report the artifact differences between 2 JFP Instances

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Project Link: https://github.com/peterdeames/jfrog-client

(back to top)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jfrog-client-1.2.3.tar.gz (17.0 kB view hashes)

Uploaded Source

Built Distribution

jfrog_client-1.2.3-py3-none-any.whl (18.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page