shields icon indicating copy to clipboard operation
shields copied to clipboard

Add [Movey] service

Open ea-open-source opened this issue 3 years ago • 4 comments

Description

This request is to add a badge for Movey (Movey.net) A crates.io-style repository of Move packages. This badge will show the latest version of a package on Movey and its download counts. We also provide data for any other versions and their perspective download count too. https://img.shields.io/badge/Movey-v1.0.0-green https://img.shields.io/badge/[email protected]

Data

Movey will be publishing a public badge endpoint at https://www.movey.net/api/v1/packages/%package%/badge As of right now we do not have any plan to add apikey or rate limit this api just yet. The API will return: example

{
    "package_name": "rand",
    "total_download_counts": 100000,
    "latest_version": "1.1.0",
    "versions": [
        {
            "versions": "1.0.0",
            "download_counts": 0
        },
        {
            "versions": "1.1.0",
            "download_counts": 11111
        }
    ]
}

Motivation

As we aim to be the Move language package repository, having a badge so that package owners can show off their statistics on their repos and let user know they are hosted on Movey would be tremendous

ea-open-source avatar Jul 28 '22 02:07 ea-open-source

Messages
:book: :sparkles: Thanks for your contribution to Shields, @ea-open-source!

Generated by :no_entry_sign: dangerJS against 00438e07a9f0f8b9cf475fdcf2fe37b061713c46

shields-ci avatar Jul 28 '22 02:07 shields-ci

Thank you for the PR. I won't speak for any of the other maintainers, but I've never heard of Move nor Movey and don't know anything about it.

We don't strictly require that issues/requests be open to a PR, but in a case where the engagement starts with a PR it's still best to provide some of the same data points we request as part of the new badge issue form:

<!--
A clear and concise description of the new badge.

- Which service is this badge for e.g: GitHub, Travis CI
- What sort of information should this badge show?
  Provide an example in plain text e.g: "version | v1.01" or as a static badge
  (static badge generator can be found at https://shields.io)
-->

:link: **Data**

<!--
Where can we get the data from?

- Is there a public API?
- Does the API requires an API key?
- Link to the API documentation.
-->

:microphone: **Motivation**

<!--
Please explain why this feature should be implemented and how it would be used.

- What is the specific use case?
-->

Additionally, it would be helpful to get some more info about the prevalence/adoption of the service and the size of its user base, what the communication channels are for reporting outages/bugs/requests., whether there are any rate limits, etc.

calebcartwright avatar Jul 29 '22 00:07 calebcartwright

Thank you for your speedy response. About Movey, we are a new service which aims to be the Move programming language package repository like Rubygems.org or Crates.io. As for user base, we are a new service and hope it will consist of most Move developers. The project is still in development and we are working with the language developers to release the first version. We have edited the PR to satisfy the new badge form but do let us know if you think anything is missing. For requests, support or reports please contact us at [email protected].

ea-open-source avatar Jul 29 '22 08:07 ea-open-source

Thanks! This is definitely the type of service we'd like to provide badges for, but to be fully transparent, it might not make sense for us to pull this in at this time because you seem to be pretty early on in the process.

When we natively add dynamic badges for a new service/provider, we really like to see that they have some established documentation (doesn't have to be anything terribly formal, we've accepted swagger docs in the past) and to be fully up and running.

My vote would be that we put this on hold until you all are a bit farther along, but will wait to hear thoughts from some of the other maintainers.

calebcartwright avatar Jul 29 '22 23:07 calebcartwright

@ea-open-source would it make sense to close this for now, or do you think you all are on the verge of having API documentation published in the near future?

calebcartwright avatar Aug 14 '22 16:08 calebcartwright

@ea-open-source would it make sense to close this for now, or do you think you all are on the verge of having API documentation published in the near future?

Sorry for the late reply and while we are close to releasing (Most PRs got merged to Move) you can go ahead and close this PR. We will reopen it when we have the documentation for our site ready.

ea-open-source avatar Aug 17 '22 03:08 ea-open-source