Project Timeline

  • Pre
  • Week 1
  • Week 2
  • Week 3
  • Week 4
  • Week 5
  • First
  • Week 6
  • Week 7
  • Week 8
  • Week 9
  • Week 10
  • Final

Community Bonding

  • Collaborate with fellow participants and knowing the FOSSology Community
  • Search for a new wrapper
  • Learn php, Twig template
  • Learn REST API concepts
  • Create a jinja template for scancode required output
  • See Database, UI for parameterized agents like reuser and decider in fossology
  • Plan a skeleton for the project(directory structure, headers and source files, basic functionality, test files)

Week 1 (June 7 - June 13)

  • Implement the scancode wrapper
  • Add functions for executing commands for scancode
  • Add functions for parsing the scancode output
  • Add functions for populating database with detected licenses and scores i.e. databasehandler

Week 2 (June 14 - June 20)

  • Test the functions and fine tune the inputs and outputs
  • Modify the corresponding Makefiles and scheduler code to include scancode agent
  • Start writing agent test for the implemented parts

Week 3 (June 21 - June 27)

  • Add the corresponding UI for the implemented functions
  • If completed start testing the wrapper with the whole project with the help of implemented UI options

Week 4 (June 28 - July 4)

  • Test the UI for its working
  • Complete the agent tests
  • Complete the license scanner with text highlight feature

Week 5 (July 5 - July 12)

July 5 - July 9

  • Testing and bug Fixing
  • By the end of this week the agent will be able to scan the uploaded files and show the result via FOSSology’s UI.
  • Result includes:
    • Licence Name as detected by Scancode
    • License match score
    • Matched text highlights
July 10 - July 12
  • Documenting the code
  • Buffer Period
  • The first evaluation will include
    • A scancode wrapper for license name and score detection
    • A working UI for detecting license names in uploaded files

First Evaluation (July 13 - July 15) 🚩

Week 6 (July 16 - July 22)

  • Work on the project based on feedback provided after first evaluation
  • Start implementing functions for copyright, url and email detection

Week 7 (July 23 - July 29)

  • Add database handling function for copyright, url and emails
  • I will add a new tables each for copyright, email, urls and corresponding functions to populate the table

Week 8 (July 30 - Aug 5)

  • Adding copyright, url and email in the UI
  • Create Twig templates for the same

Week 9 (Aug 6 - Aug 12)

  • Improve code quality
  • Adding documentation and creating reports
  • Buffer Period

Week 10 (Aug 13 - Aug 20)

  • Testing and bug fixing
  • Final submission of work

Final Evaluation 🚩