open-next / losh-reporter Goto Github PK

## File Types

- search for MIME types of associated source and export files
- also state for how many projects source files are even defined

**NOTE: From here on, there is no more data, becasue the required fields do not exist.**

# Platform-specific Insights

## OSHWA

The Open Source Hardware Association (OSHWA) runs a certification program for OSH. Certified projects are officially deemed to be fully compliant to the OSHWA definition of OSH ([ref](https://www.oshwa.org/definition/)).

@fig:oshwa-cert-cumul shows the historical development of certificates issued in the past years

# <!-- TODO Robin (NO-CAN-DO: No creation-time data) line plot of cumulated certifications over time (x-axis could be e.g. per quarter, but that's totally optional) -->
# #fig:oshwa-cert-cumul

@fig:oshwa-cert-rate and @fig:oshwa-cert-growth show the derived certification rate and relative growth.

# <!-- TODO Robin (NO-CAN-DO: No creation-time data) line plot of (certifications per year) over time -->
# #fig:oshwa-cert-rate

# <!-- TODO Robin (NO-CAN-DO: No creation-time data) horizontal bar chart with growth of (certifications per year) relative to the year before-->
# #fig:oshwa-cert-growth

A total of {number-of-biggest-OSHWA-licensors-adding-up-to-50%} creators have combined to certify ~50 % of all currently OSHWA-certified projects. So {number-of-biggest-OSHWA-licensors-adding-up-to-50% / oshwa-unique-licensors-total} % of creators make half of OSHWA's database. On the other end we have {number-of-OSHWA-licensors-with-only-1-certificate} holders of a single certificate ( % of all creators). This calculates to a median of nearly {OSHWA-median-certificates-per-licensor} per participating individual or organization.

@fig:oshwa-cert-rate illustrates the distribution of certifications among creators.

# <!-- TODO Robin vertical bar chart with certifications per licensor-->
# #fig:oshwa-cert-rate

Since OSHWA also publishes the location of the certified OSH projects (or rather the corresponding team or organisation, presumingly), we can also see how these certifications distribute among countries, as shown in @fig:oshwa-cert-country and @fig:oshwa-cert-country-map.

# <!-- TODO Robin (NO-CAN-DO: No geo-location data) vertical bar chart with certifications per country -->
# #fig:oshwa-cert-country 

# <!-- TODO Robin (NO-CAN-DO: No geo-location data) world map with certifications per country (see https://i0.wp.com/oshdata.wpcomstaging.com/wp-content/uploads/2020/09/cert-density-by-country.png?resize=768%2C467&ssl=1)-->
# #fig:oshwa-cert-country-map.

<!--- NOTE: the world map is totally optional; if that's to hard to implement → no biggy -->

## Wikifactory

Wikifactory is an online platform dedicated to OSH. It is designed to need specific needs and offer specialised services that arise in the development (and production) process of OSH. The platform itself is not open source, but free to use (however, there are some cool premium features).
It is important to mention that lots of projects on Wikifactory are not open source and hence are not considered in the following statistics.

@fig:wif-proj-hist-cumul illustrates the historical growth of OSH projects on Wikifactory; @fig:wif-proj-tag-cloud shows the most popular tags of those projects in a word cloud.

# <!-- TODO Robin (NO-CAN-DO: No creation-time data) line plot of cumulated project creations over time (`dateCreated`) (x-axis could be e.g. per quarter, but that's totally optional) -->
# #fig:wif-proj-hist-cumul

# <!-- TODO Robin (NO-CAN-DO: No tag data) word cloud of most used tags -->
# #fig:wif-proj-tag-cloud

The following sections aim to give you a feeling for the OSH projects hosted on that platform :)

### Project Locations

Since some users on wikifactory also specify the location of their project, we can also see how those projects distribute among countries, as shown in @fig:wif-proj-country and @fig:wif-proj-country-map.

# <!-- TODO Robin (NO-CAN-DO: No geo-location data) vertical bar chart with projects per country (`createdInRegion`) -->
# #fig:wif-proj-country

# <!-- TODO Robin (NO-CAN-DO: No geo-location data) world map with projects per country (see https://i0.wp.com/oshdata.wpcomstaging.com/wp-content/uploads/2020/09/cert-density-by-country.png?resize=768%2C467&ssl=1)-->
# #fig:wif-proj-country-map

<!--- NOTE: the world map is totally optional; if that's to hard to implement → no biggy -->

### Most Downloaded

It may be safe to say that OSH projects generally aim to be replicated and therewith have relevant applications in practice, improving people's lifes (in whichever way).
An indicator for practical replication of a projects is the number of downloads of its technical documentation.

On average an OSH project on Wikifactory is downloaded {average-archiveDownloadCount-WIF} times; [{name-of-WIF-project-with-most-downloads}]({repoURL-of-WIF-project-with-most-downloads}) is currently the most downloaded project with now totalling {archiveDownloadCount-of-project-with-most-downloads-WIF} downloads.

@fig:wif-downloads-dist shows the distribution of downloads per project, @fig:wif-downloads-top20 the top 20 of most downloaded OSH projects on wikifactory.

# <!-- TODO Robin (NO-CAN-DO: No view data) horizontal bar chart with distribution of downloads per project-->
# #fig:wif-downloads-dist

# <!-- TODO Robin (NO-CAN-DO: No view data) vertical bar chart with top 20 projects with most downloads-->
# #fig:wif-downloads-top20

### Most Viewed

The popularity of open source projects depends on many factors, not only the awesomeness of it's technical solution. Especially for commercialised projects, this may be an important performance indicator; and of course, popular projects may have an easier game when it comes to actual community building.
An indicator for how much attention a project receives is its number of views.

On average an OSH project on Wikifactory is viewed {average-pageviewsCount-WIF} times; [{name-of-WIF-project-with-most-views}]({repoURL-of-WIF-project-with-most-views}) is currently the most viewed project with now totalling {pageviewsCount-of-project-with-most-views-WIF} views.

@fig:wif-views-dist shows the distribution of total views per project, @fig:wif-views-top20 the top 20 of most viewed OSH projects on wikifactory.

# <!-- TODO Robin (NO-CAN-DO: No view data) horizontal bar chart with distribution of total views per project-->
# #fig:wif-views-dist

# <!-- TODO Robin (NO-CAN-DO: No view data) vertical bar chart with top 20 projects with most views-->
# #fig:wif-views-top20 

### Most Contributions

Development on Wikifactory is version-controlled per "contribution" made (sort of equals "commits" on git-based systems).
An indicator for how much development work has been carried out on a single project is its number of contributions.

On average an OSH project on Wikifactory consists of {average-contributionCount-WIF} contributions; [{name-of-WIF-project-with-most-contributions}]({repoURL-of-WIF-project-with-most-contributions}) is currently the project with most contribution with now totalling {contributionCount-of-project-with-most-contributions-WIF} contributions. 

@fig:wif-contributions-dist shows the distribution of total contributions per project, @fig:wif-contributions-top20 the top 20 of OSH projects most contributions on wikifactory.

# <!-- TODO Robin (NO-CAN-DO: No contributors data) horizontal bar chart with distribution of contributions per project-->
# #fig:wif-contributions-dist

# <!-- TODO Robin (NO-CAN-DO: No contributors data) vertical bar chart with top 20 projects with most contributions-->
# #fig:wif-contributions-top20

### Most Contributors

Community is an essential factor for successful open source projects.
An indicator for how wide the developer base of a single project is, is its number of contributors.

On average an OSH project on Wikifactory has {average-contributors-WIF} contributors; [{name-of-WIF-project-with-most-contributors}]({repoURL-of-WIF-project-with-most-contributors}) is currently the project with most contributors with now totalling {contributors-of-project-with-most-contributors-WIF} contributors. 

@fig:wif-contributors-dist shows the distribution of total contributors per project, @fig:wif-contributors-top20 the top 20 of OSH projects most contributors on wikifactory.

# <!-- TODO Robin (NO-CAN-DO: No contributors data) horizontal bar chart with distribution of contributors per project-->
# #fig:wif-contributors-dist

# <!-- TODO Robin (NO-CAN-DO: No contributors data) vertical bar chart with top 20 projects with most contributors-->
# #fig:wif-contributors-top20

# <!-- TODO Robin (NO-CAN-DO: No contributors data) vertical bar chart with top 20 projects with most contributors-->

---------------------------------------------------------------------------
ModuleNotFoundError                       Traceback (most recent call last)
Input In [1], in <cell line: 1>()
----> 1 import reporter.core.requester as req
      2 import reporter.generator as gen
      3 import reporter.templater as templater

File ~/Documents/git/IPK/LOSH-Reporter/reporter/core/requester.py:8, in <module>
      6 import os
      7 import json
----> 8 from dotenv import load_dotenv
      9 import requests
     11 from reporter.core.errors import NoQueryProvided, RequestError, NoEnvironmentVariableProvided

ModuleNotFoundError: No module named 'dotenv'

---------------------------------------------------------------------------
NameError                                 Traceback (most recent call last)
Input In [2], in <cell line: 23>()
     21 y_selector="repoHosts.count"
     22 acc = 5
---> 23 x, y = fetch_xy(x_selector, y_selector)
     24 x, y = accum_below_abs(x, y, acc)
     25 fig_01, ax_01 = piechart_create(
     26     x,
     27     y,
     28     title="repo-hosts-percent",
     29     label="repo-host",
     30     legend_vals=True)

NameError: name 'fetch_xy' is not defined

---------------------------------------------------------------------------
NameError                                 Traceback (most recent call last)
Input In [1], in <cell line: 6>()
      4 y_selector="repoHosts.count"
      5 acc = 5
----> 6 x, y = fetch_xy(x_selector, y_selector)
      7 x, y = accum_below_abs(x, y, acc)
      8 fig, ax = barchart_create(x, y, title="repo-hosts", label="count")

NameError: name 'fetch_xy' is not defined

Hi Hi Moe! :)

I have attached a yaml file with all the fields associated to the projects that can be obtained from the Wikifactory GraphQl API.

This API can be accessed by going to https://wikifactory.com/api/graphql

However, I believe it is worth for you to know how did I get that list of fields.

If you go to the API URL, on the right side you will see a "Docs" button.
It opens a "Documentation Explorer" view, that allows you to inspect the data schema provided by Wikifactory. Among others, you can search for "Project" (notice the capital P). You should then see something similar to the attached screenshot, with all the fields shown in an interactive way.

Is that the information you were looking for?
If that is the case, let me know if you need help to operate with the API.

Otherwise, please, do let me 

know what are you missing, and I will try to better help you

Cheers!

FeaturedIn: String
id: ID!
type: String
slug: String
creatorId: Int!
createdInRegion: String
spaceId: Int
dateCreated: DateTime
lastUpdated: DateTime
whitelabel: String
whiteLabelOnlyContent: Boolean
lastCommentedAt: DateTime
lastActivityAt: DateTime!
commentsCount: Int
likesCount: Int
followersCount: Int
score: Float!
pageviewsCount: Int!
publicRead: Boolean!
registeredRead: Boolean!
contentPtrId: ID!
name: String
description: String
imageId: Int
license: License
contributionCount: Int
archiveDownloadCount: Int!
contextId: Int!
projectType: project_type!
importStatus: ImportStatus
importJobId: String
slackThreadTs: String
slackContributionThreadTs: JSONString!
isExactForkCopy: String
hasImage: String
starCount: Int
headContribution: String
canAppearOnHome: String
hasContributions: String
featuredIn: String
image: File
phase: ProjectPhase
context: Context
creator: User
space: Space
followers(sortBy: StringfilterBy: [[String]]contains: [String]notContains: [[String]]whitelabels: [String]before: Stringafter: Stringfirst: Intlast: Int): ProfileConnection
tags: [Tag]
collections: [Collection]
comments(sortBy: Stringorigin: IDbefore: Stringafter: Stringfirst: Intlast: Int): CommentConnection
contributions(projectId: IDsortBy: Stringbefore: Stringafter: Stringfirst: Intlast: Int): ContributionConnection
contentType: String
parentSlug: String
isPrivate: Boolean
snippet: String
inviteLink: InviteLink
socialAccounts: [Social]
forum: Forum
followingCount: Int
canUpdate: Boolean
canDelete: Boolean
content: Content
parentContent: Content
inSpace: Space
avatar: File
imageFallbackChar: String
title: String
commenters: [Profile]
pageViews: Int
descriptionSnippet: String
private: Boolean
forkedFrom: DiffInfo
pendingOperations: [ContribOp]
conflicts: [Conflict]
conflictsParent: String
contributionUpstream: Contribution
lastZipGenerated: Boolean
tracker: Tracker
creatorProfile: Profile
isStarred: Boolean
forkCount: Int
contribution(version: String): Contribution
contributors(sortBy: StringfilterBy: [[String]]contains: [String]notContains: [[String]]whitelabels: [String]before: Stringafter: Stringfirst: Intlast: Int): ProfileConnection
fileHistory(uuid: Stringbefore: Stringafter: Stringfirst: Intlast: Int): OpsConnection