Skip to content

Commit ba34b37

Browse files
Merge branch 'deltacode_docs_update' of https://github.com/Pratikrocks/aboutcode into Pratikrocks-deltacode_docs_update
Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
2 parents 4734acc + 6937266 commit ba34b37

2 files changed

Lines changed: 69 additions & 0 deletions

File tree

docs/source/archive/gsoc-toc.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ More about GSoc - <https://summerofcode.withgoogle.com/about/>_
1313
.. toctree::
1414
:maxdepth: 2
1515

16+
gsoc/gsoc21_final_report
1617
gsoc/gsoc19_final_report
1718
gsoc/gsoc_2019
1819
gsoc/gsoc_2018
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
Google Summer of Code 2021 - Final report
2+
=========================================
3+
4+
Project: Virtual Codebase support in DeltaCode
5+
----------------------------------------------------------
6+
7+
**Pratik Dey <pratikrocks.dey11@gmail.com>**
8+
9+
Project Overview
10+
----------------
11+
12+
The goal of this proposal is to refactor DeltaCode to use Scancode-Toolkit’s Virtual Codebase
13+
class. This refactoring will allow DeltaCode to be a library as opposed to only be used as a
14+
CLI tool, moreover, this refactor will allow DeltaCode to determine deltas much more effectively
15+
in the form of BFS tree scan of the two tree structures unlike indexing the entire codebase.
16+
17+
18+
Main Objectives of the project
19+
------------------------------
20+
21+
- Migrate to using VirtualCodebase from the latest scancode.
22+
- Create DeltaCode documentation on Read The Docs.
23+
- Provide the support for fingerprint plugin for Virtual Codebase.
24+
- Provide the Support for enabling Virtual Codebase to scan files having full root paths as their
25+
location.
26+
27+
The Project
28+
-----------
29+
30+
- Virtual Codebase Integration with Deltacode
31+
- Removing redundant File and License Objects
32+
- Provided options in deltacode scans
33+
- Added Docker Script for Dockerizing the Deltacode Application and make it platform-independent.
34+
- Add Read the Docs Support to Deltacode.
35+
36+
I have completed all the tasks that were in the scope of this GSoC project.
37+
38+
Pull Requests
39+
-------------
40+
41+
- https://github.com/nexB/deltacode/pull/167 [Merged]
42+
- https://github.com/nexB/deltacode/pull/176 [Open]
43+
- https://github.com/nexB/deltacode/pull/171 [Open]
44+
- https://github.com/nexB/deltacode/pull/178 [Open]
45+
- https://github.com/nexB/deltacode/pull/168 [Open]
46+
47+
Links
48+
-----
49+
50+
..
51+
[Project Link] https://summerofcode.withgoogle.com/organizations/5312205181943808/#6516503005888512
52+
53+
- `Project Details <https://summerofcode.withgoogle.com/organizations/5312205181943808/#6516503005888512>`_
54+
- `Proposal <https://docs.google.com/document/d/19btijAja6x8hbD_X-dGor1RiiEGF3-1gEHYkzqzC3xQ/edit#heading=h.z6ne0og04bp5>`_
55+
- `ScanCode Toolkit <https://github.com/nexB/scancode-toolkit>`_
56+
- `DeltaCode <https://github.com/nexB/deltacode>`_
57+
58+
------------
59+
60+
I’ve had a wonderful time during these three months and have learned plenty of things. I would
61+
really like to thank `@pombredanne <https://github.com/pombredanne>`_,
62+
`@majurg <https://github.com/majurg>`_, and `@JonoYang <https://github.com/JonoYang>`_ for their
63+
constant support throughout the journey. From good job claps to nit-picky constructive
64+
code-reviews, I enjoyed every bit of this GSoC project.
65+
66+
I had a wonderful time during the GSOC, I learned a lot of things during this time. I really enjoyed this project.
67+
I would really like to thank my mentors `@pombredanne <https://github.com/pombredanne>`_, `@majurg <https://github.com/majurg>`_, and `@TG1999 <https://github.com/TG1999>`_,
68+
and all other About code members who constantly supported me throughout this project.

0 commit comments

Comments
 (0)