Refactor tendermint directory to project root by z-bowen · Pull Request #2401 · bigchaindb/bigchaindb

z-bowen · 2018-07-24T10:32:12Z

Problem: The BigchainDB class should be defined in project root, not in the /tendermint directory.

Solution

Moved the BigchainDB class to lib.py in project root, as well as the rest of the contents from the /tendermint directory, and removed /tendermint.

Solution: Remove core.py. Refactor BigchainDB Class to remove inheritance from Bigchain.

…its, as I don't know what I'm doing, and I can't experiment without running the CI... Sorry in advance!

…gchaindb into z-bowen-remove_bigchain_class

…ivate method, so I had to align with that.

Solution: resolved merge conflicts to excavate Block class from my branch

Solution: Merged and repushed

Solution: Merge changes into Master

Solution: Removed the /tendermint directory and moved its contents to project root

ttmc · 2018-07-24T10:57:27Z

docs/server/source/appendices/tendermint-integration.rst

@@ -1,26 +0,0 @@
-######################


You will also have to remove the reference to this page from the file that generates the table of contents for the Appendices, i.e. docs/server/source/appendices/index.rst

Currently, when I go to the /docs/server/ directory and do make html, I get the error message:

Warning, treated as error: /home/troy/repos/bigchaindb/docs/server/source/appendices/index.rst:4:toctree contains reference to nonexisting document 'appendices/tendermint-integration' Makefile:56: recipe for target 'html' failed make: *** [html] Error 2

ttmc · 2018-07-24T12:28:26Z

There are also some Flake8 errors --- see the Travis CI reports.

Solution: Had to play around with the order of imports to avoid cyclic dependencies, but its working and style compliant now

codecov-io · 2018-07-24T19:43:09Z

Codecov Report

Merging #2401 into master will decrease coverage by <.01%.
The diff coverage is 92.78%.

@@            Coverage Diff            @@
##           master   #2401      +/-   ##
=========================================
- Coverage    86.9%   86.9%   -0.01%     
=========================================
  Files          38      38              
  Lines        2169    2168       -1     
=========================================
- Hits         1885    1884       -1     
  Misses        284     284

Solution: Removed the references to /tendermint

Solution: The import is there so I can import App directly from bigchaindb, rather than from bigchaindb.core (which I think improves code readability. I added a # noqa to silence Flake8.

ttmc · 2018-07-25T09:06:16Z

You fixed the problem with index.rst, but now there is some other problem with building the docs:

Warning, treated as error:
autodoc: failed to import class 'BigchainDB' from module 'bigchaindb.tendermint'; the following exception was raised:
No module named 'bigchaindb.tendermint'

The bigchaindb.tendermint module is referenced in the file docs/server/source/appendices/the-bigchaindb-class.rst.

Also there are some docstrings which still refer to the bigchaindb.tendermint module, and that might cause problems with documentation generation based on those docstrings.

…e rst files cause Sphinx to fail Solution: Updated the autodoc files to use `bigchaindb.BigchainDB` instead

@patch

…n a disabled test Solution: Updated the @patch for completeness

Solution: Removed the /tendermint directory and moved its contents to project root

Solution: Had to play around with the order of imports to avoid cyclic dependencies, but its working and style compliant now

Solution: Removed the references to /tendermint

Solution: The import is there so I can import App directly from bigchaindb, rather than from bigchaindb.core (which I think improves code readability. I added a # noqa to silence Flake8.

…e rst files cause Sphinx to fail Solution: Updated the autodoc files to use `bigchaindb.BigchainDB` instead

@patch

…n a disabled test Solution: Updated the @patch for completeness

…b.com:z-bowen/bigchaindb into refactor-tendermint-directory-to-project-root

z-bowen added 18 commits June 28, 2018 12:01

Problem: core.py contains an unused class, Bigchain

920fe2b

Solution: Remove core.py. Refactor BigchainDB Class to remove inheritance from Bigchain.

Problem: core.py contains an unused class, Bigchain

e71fd5d

Solution: Remove core.py. Refactor BigchainDB Class to remove inheritance from Bigchain.

Merge branch 'z-bowen-remove_bigchain_class'

97946bd

Merge remote-tracking branch 'upstream/master'

d5ab427

Fixed flake8 complaint about too many blank lines

a3b9bb6

Attempting to fix Sphinx docs. This may result in some redundant comm…

80c90c7

…its, as I don't know what I'm doing, and I can't experiment without running the CI... Sorry in advance!

Attempting to fix Sphinx docs. This may result in some redundant comm…

8176fc6

…its, as I don't know what I'm doing, and I can't experiment without running the CI... Sorry in advance!

Merge branch 'remove_bigchain_class' of https://github.com/z-bowen/bi…

47b08ea

…gchaindb into z-bowen-remove_bigchain_class

Merge branch 'z-bowen-remove_bigchain_class'

1b2e9b8

Merge remote-tracking branch 'upstream/master'

78d7902

Updating from master changed BigchainDB.process_post_response to a pr…

f42c6ad

…ivate method, so I had to align with that.

Fixed a couple stale references to bigchaindb.Bigchain in docstrings

8f18948

Missed a reference to Bigchain in a patch call...

5dbe4e4

*Problem: Merge conflict with removal of Block class

f33924a

Solution: resolved merge conflicts to excavate Block class from my branch

*Problem: Merge conflicts with bigchaindb#2342

93c011e

Solution: Merged and repushed

*Problem: Merge conflict from bigchaindb#2342

c6b1011

Solution: Merge changes into Master

Merge branch 'master' of github.com:bigchaindb/bigchaindb

a055583

Problem: BigchainDB class should be part of project root

04e8ef2

Solution: Removed the /tendermint directory and moved its contents to project root

z-bowen requested a review from ldmberman July 24, 2018 10:32

ttmc suggested changes Jul 24, 2018

View reviewed changes

ldmberman approved these changes Jul 24, 2018

View reviewed changes

Problem: Flake8 complained that imports were not at the top of the file

130085d

Solution: Had to play around with the order of imports to avoid cyclic dependencies, but its working and style compliant now

z-bowen added 2 commits July 24, 2018 21:44

Problem: Stale reference to /tendermint directory in the index

3ae59ab

Solution: Removed the references to /tendermint

Problem: Flake8 complaining of unused import in __init__.py

160895e

Solution: The import is there so I can import App directly from bigchaindb, rather than from bigchaindb.core (which I think improves code readability. I added a # noqa to silence Flake8.

z-bowen added 2 commits July 25, 2018 14:30

Problem: Stale references to bigchaindb.tendermint.BigchainDB in th…

5ee3c6e

…e rst files cause Sphinx to fail Solution: Updated the autodoc files to use `bigchaindb.BigchainDB` instead

Problem: Stale reference to the tendermint directory in an @patch i…

f7a6a68

…n a disabled test Solution: Updated the @patch for completeness

ttmc approved these changes Jul 25, 2018

View reviewed changes

z-bowen added 8 commits July 25, 2018 16:40

Merge branch 'master' of github.com:bigchaindb/bigchaindb

2dfe46a

Problem: BigchainDB class should be part of project root

507fe1e

Solution: Removed the /tendermint directory and moved its contents to project root

Problem: Flake8 complained that imports were not at the top of the file

ddce2d5

Solution: Had to play around with the order of imports to avoid cyclic dependencies, but its working and style compliant now

Problem: Stale reference to /tendermint directory in the index

186e0e9

Solution: Removed the references to /tendermint

Problem: Flake8 complaining of unused import in __init__.py

82bedb9

Solution: The import is there so I can import App directly from bigchaindb, rather than from bigchaindb.core (which I think improves code readability. I added a # noqa to silence Flake8.

Problem: Stale references to bigchaindb.tendermint.BigchainDB in th…

c457530

…e rst files cause Sphinx to fail Solution: Updated the autodoc files to use `bigchaindb.BigchainDB` instead

Problem: Stale reference to the tendermint directory in an @patch i…

1616032

…n a disabled test Solution: Updated the @patch for completeness

Merge branch 'refactor-tendermint-directory-to-project-root' of githu…

037fc9b

…b.com:z-bowen/bigchaindb into refactor-tendermint-directory-to-project-root

ttmc merged commit 2386ca9 into bigchaindb:master Jul 25, 2018

ldmberman mentioned this pull request Jul 26, 2018

Problem: (BEP-21) no way to propose validator election #2392

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor tendermint directory to project root#2401

Refactor tendermint directory to project root#2401
ttmc merged 31 commits intobigchaindb:masterfrom
z-bowen:refactor-tendermint-directory-to-project-root

z-bowen commented Jul 24, 2018

Uh oh!

ttmc Jul 24, 2018

Uh oh!

z-bowen Jul 24, 2018

Uh oh!

ttmc commented Jul 24, 2018

Uh oh!

codecov-io commented Jul 24, 2018 •

edited

Loading

Uh oh!

ttmc commented Jul 25, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

z-bowen commented Jul 24, 2018

Solution

Uh oh!

ttmc Jul 24, 2018

Choose a reason for hiding this comment

Uh oh!

z-bowen Jul 24, 2018

Choose a reason for hiding this comment

Uh oh!

ttmc commented Jul 24, 2018

Uh oh!

codecov-io commented Jul 24, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

ttmc commented Jul 25, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov-io commented Jul 24, 2018 •

edited

Loading