You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11Lines changed: 11 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -255,6 +255,16 @@ Specifically, for each repository, the response will include:
255
255
*`repository`: String containing the repository URL.
256
256
*`platform`: String, only `Wikifactory` for now.
257
257
*`requested_data`: Object containing the following:
258
+
*`files_editability`: Object containing the following:
259
+
*`files_count`: Integer number of (presumed to be) CAD files that are not text documents or data files (like CSV).
260
+
*`files_openness`: Object containing the following:
261
+
*`open`: Integer number of files using open formats.
262
+
*`closed`: Integer number of files using closed/proprietary formats.
263
+
*`other`: Integer number of files not categorised in either of the above.
264
+
*`files_encoding`: Object containing the following:
265
+
*`binary`: Integer number of files using binary formats.
266
+
*`text`: Integer number of files using text-based formats.
267
+
*`other`: Integer number of files not categorised in either of the above.
258
268
*`files_info`: Object containing the following:
259
269
*`total_files`: Integer of total number of files in the repository.
260
270
*`ecad_files`: Integer number of electronic CAD files.
@@ -309,6 +319,7 @@ Specifically, for each repository, the response will include:
309
319
310
320
Notes:
311
321
322
+
* For `files_editability` above, filetypes are identified by file extensions. The categories and mapping are documented in [`oshminer/filetypes.py`](./oshminer/filetypes.py), and can be traced the [`osh-file-types` list](https://gitlab.com/OSEGermany/osh-file-types/) by Open Source Ecology Germany.
312
323
* For `files_info` above, filetypes are identified by file extensions. The categories and mapping are located in [`oshminer/filetypes.py`](./oshminer/filetypes.py).
313
324
* The `license` information and formatting is largely based on that from the GitHub-managed [choosealicense.com repository](https://github.com/github/choosealicense.com), with the exception of some open source hardware licenses which were manually added.
0 commit comments