eellak / clio Goto Github PK

SPDX license list v3.4 was published on 208-12-20.
The initial loaded data should reflect this.

For better UI/UX of Clio, a robust fronted design is needed. I tried to design landing page of Clio, please have a look at it. Suggestions from contributors are most welcome.

-> Current Landing Page of Clio

-> My new Design

The new Design Includes

1. A Tour of the website for better user experience
2. Header and footer
3. A newly Designed Clio's logo (still open for suggestions)
4. A sign in option to register new users
5. Animation for better user experience
   -> This is just an initial design to get feedback for further improvement.
   -> I will also try to implement material design and will compare the result.
   Please give feedback, Thank you!

Since external components have been introduced. they should be documented.

They should be listed in documentation files (name, origin, license, etc.) and the license texts have to be placed in the Licenses directory.

Since Alchemy is used, the code should work on more than a single database system.
However, the current documentation only talks about MySQL.

Equivalent instructions should be added for SQLite -- and ideally PostgreSQL.

besides the name and short identifier, each license should also have its complete text.

The link given in the license text is not clickable, user has to copy the link manually and copy in browser to view complete license.

A logo for Clio is needed for home page of Clio, which can also be used as a favicon.

if feasible, I think it would be better to move the content of valid_relationship and valid_delivery outside the source code, so that the options are not hardcoded (since they might change in the future).
https://github.com/eellak/clio/blob/master/src/specification.py

In the new license list,there is no data about the whether the data is considered free by FSF.
So, there is no need for the FSF Free/Libre field.

While creating a license, the license category should display a dropdown with three options: permissive, weak copyleft, strong copyleft.

I think we should add a Linter and attach it as a pre commit hook if possible to ensure that python code follows PEP 8 conventions and a consistent code style is followed.
Pylint can be used to accomplish this.
Consider it as a secondary task but it will help to write a robust code and will help in easy debugging

A functionality is required to remember user credentials, so that whenever a user is frequently using clio, login with each sign in can be avoided.

On running populate_dp.py to populate database no progress is shown in console, which is very inconvenient to monitor progress as this process takes appreciable amount of time to complete.

• Add progress bar (like the one shown in the gif) in populate_db.py

This improvement will help developer not user

Add update Button on license page to fetch new/modified licenses whenever clicked.

As described in the top-level README, all files should have a clear license statement, in the form of a SPDX-License-Identifier: comment.

As mentioned by @zvr in his comment on Pull Request #48, a functionality is needed through which database can be populated without using .csv file (large if we want to solve #47 ).
Note: In this method internet connection is required to populate the database, advantage of merging PR #48 is that anyone can populate database without using internet.

Currently license category field in Clio is empty, update the field with permissive, weak copyleft and strong copyleft.

There is formatting issue while exporting pdf file of components.

Hi @zvr , I would like to contribute to the CLIO project.Can you please guide me on the next course of action?

Currently, user cannot export complete information about any license. After fix #48 or fix #53 clio is able to display full license info. including license text. A functionality is required to export data in pdf and excel sheet.

In the current version of Clio there is no facility to display exceptions or deprecated license identifiers.
A functionality is required to handle all the three entries:

1. SPDX License List
2. License exceptions
3. Deprecated License Identifiers

Current clio version. (showing only licenses)

SPDX License list showing all the three entries.

1) SPDX License List

2) License exceptions

3) Deprecated License Identifiers

The design idea of REST when you are designing an API via URLs is that you have objects and actions.

You are using /license/<int:id> to view licenses (and similarly with component and product) but the actions are reversed (e.g. /create/component/).

They have to be updated to be in the form object/action, or noun/verb (e.g., /license/create).

The license list should be updated to the latest list published by SPDX , v3.4.
https://spdx.org/licenses/

Current version of CLIO is not responsive. A new design is needed for better UI/UX.

In the component page, all the entries load at one shot. Considering that Datatables are being used (along with features like sort, search, export), it is important that all of the contents of the database is transferred to the client side. But the number of such entries is large, hence it takes a lot of time.

@zvr @gopuvenkat Could you please share your inputs on the same.