Skip to content

Commit 6937266

Browse files
committed
added the GSOC report
Signed-off-by: Pratik Dey <pratikrocks.dey11@gmail.com>
1 parent 3058d75 commit 6937266

2 files changed

Lines changed: 80 additions & 1 deletion

File tree

docs/source/deltacode/comprehensive_installation.rst

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Comprehensive Installation
22
==========================
33

4-
DeltaCode requires Python 3.6(or above) and is tested on Linux, Mac, and Windows. Make sure Python 3.6 (or above) is
4+
DeltaCode requires Python 3.6+ and is tested on Linux, Mac, and Windows. Make sure Python 3.6 (or above) is
55
installed first.
66

77
System Requirements
@@ -123,3 +123,15 @@ Un-installation
123123

124124
- Delete the directory in which you extracted DeltaCode.
125125
- Delete any temporary files created in your system temp directory under a deltacode directory.
126+
127+
Using the docker image for testing Deltacode
128+
---------------
129+
130+
- In the project root directory run `docker-compose up`.
131+
- This will create an image of deltacode with the name `delta_code`.
132+
- To verify the image created run `docker image ls`.
133+
- To run the image run `docker run -itd --name <specific name of container> delta_code `.
134+
- The above command runs the image in the background and creates a container with the name as per specified.
135+
- To execute the container in a bash mode run `docker exec -it <container name> bash`.
136+
- The above command will open a bash shell in the container.
137+
- To run the commands / pytest inside the shell you can use the commands as specified in the documentations.
Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
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 class.
13+
This refactoring will allow DeltaCode to be a library as opposed to only be used as a CLI tool, moreover,
14+
this refactor will allow DeltaCode to determine deltas much more effectively in the form of BFS tree scan
15+
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 location.
25+
26+
The Project
27+
-----------
28+
29+
- Virtual Codebase Integration with Deltacode
30+
- Removing redundant File and License Objects
31+
- Provided options in deltacode scans
32+
- Added Docker Script for Dockerizing the Deltacode Application and make it platform-independent.
33+
- Add Read the Docs Support to Deltacode.
34+
35+
I have completed all the tasks that were in the scope of this GSoC project.
36+
37+
Pull Requests
38+
-------------
39+
40+
- https://github.com/nexB/deltacode/pull/167 [Merged]
41+
- https://github.com/nexB/deltacode/pull/176 [Open]
42+
- https://github.com/nexB/deltacode/pull/171 [Open]
43+
- https://github.com/nexB/deltacode/pull/178 [Open]
44+
- https://github.com/nexB/deltacode/pull/168 [Open]
45+
46+
Links
47+
-----
48+
49+
..
50+
[Project Link] https://summerofcode.withgoogle.com/organizations/5312205181943808/#6516503005888512
51+
52+
- `Project Details <https://summerofcode.withgoogle.com/organizations/5312205181943808/#6516503005888512>`_
53+
- `Proposal <https://docs.google.com/document/d/19btijAja6x8hbD_X-dGor1RiiEGF3-1gEHYkzqzC3xQ/edit#heading=h.z6ne0og04bp5>`_
54+
- `ScanCode Toolkit <https://github.com/nexB/scancode-toolkit>`_
55+
- `DeltaCode <https://github.com/nexB/deltacode>`_
56+
57+
------------
58+
59+
I’ve had a wonderful time during these three months and have learned plenty of things. I would
60+
really like to thank `@pombredanne <https://github.com/pombredanne>`_,
61+
`@majurg <https://github.com/majurg>`_, and `@JonoYang <https://github.com/JonoYang>`_ for their
62+
constant support throughout the journey. From good job claps to nit-picky constructive
63+
code-reviews, I enjoyed every bit of this GSoC project.
64+
65+
I had a wonderful time during the GSOC, I learned a lot of things during this time. I really enjoyed this project.
66+
I would really like to thank my mentors `@pombredanne <https://github.com/pombredanne>`_, `@majurg <https://github.com/majurg>`_, and `@TG1999 <https://github.com/TG1999>`_,
67+
and all other About code members who constantly supported me throughout this project.

0 commit comments

Comments
 (0)