https://github.com/earwig/bitshift
A semantic search engine for source code
https://github.com/earwig/bitshift
python search-engine
Last synced: about 1 year ago
JSON representation
A semantic search engine for source code
- Host: GitHub
- URL: https://github.com/earwig/bitshift
- Owner: earwig
- License: mit
- Created: 2014-03-27T16:59:26.000Z (over 12 years ago)
- Default Branch: develop
- Last Pushed: 2020-10-14T17:27:57.000Z (over 5 years ago)
- Last Synced: 2025-04-30T20:32:52.758Z (about 1 year ago)
- Topics: python, search-engine
- Language: Python
- Homepage: https://bitshift.benkurtovic.com/
- Size: 3.87 MB
- Stars: 33
- Watchers: 7
- Forks: 6
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
bitshift
========
bitshift is a semantic search engine for source code developed by Benjamin
Attal, Ben Kurtovic, and Severyn Kozak. This README is intended for developers
only. For a user overview of the project:
* read our [about page](http://bitshift.it/)
* watch our [demo video](https://vimeo.com/98697078)
Branches
--------
- `master`: working, tested, version-numbered code - no direct commits; should
only accept merges from `develop` when ready to release
- `develop`: integration branch with unreleased but mostly functional code -
direct commits allowed but should be minor
- `feature/*`: individual components of the project with untested, likely
horribly broken code - branch off from and merge into `develop` when done
Style
-----
bitshift uses [SASS][SASS] for styling; compile the stylesheets to CSS with
`sass --watch static/sass/:static/css`.
Documentation
-------------
To build documentation, run `make html` from the `docs` subdirectory. You can
then browse from `docs/build/html/index.html`.
To automatically update the API documentation structure (necessary when adding
new modules or packages, but *not* when adding functions or changing
docstrings), run `sphinx-apidoc -fo docs/source/api bitshift` from the project
root. Note that this will revert any custom changes made to the files in
`docs/source/api`, so you might want to update them by hand instead.
[SASS]: http://sass-lang.com/guide
Releasing
---------
- Update `__version__` in `bitshift/__init__.py`, `version` in `setup.py`, and
`version` and `release` in `docs/conf.py`.